featurebase-node 0.3.0 → 0.5.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 +17 -0
- package/README.md +31 -0
- package/client.d.mts +12 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +12 -6
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +54 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +54 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/index.d.mts +1 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +1 -0
- package/index.d.ts.map +1 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -0
- package/index.mjs.map +1 -1
- package/package.json +11 -1
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/changelogs/changelogs.d.mts +16 -60
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +16 -60
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +41 -9
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +41 -9
- 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 +2 -2
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts +2 -2
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/changelogs/subscribers.js +10 -2
- package/resources/changelogs/subscribers.js.map +1 -1
- package/resources/changelogs/subscribers.mjs +10 -2
- package/resources/changelogs/subscribers.mjs.map +1 -1
- package/resources/feedback/boards.d.mts +2 -2
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +2 -2
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +10 -2
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +10 -2
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +15 -59
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +15 -59
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +36 -8
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +36 -8
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +2 -2
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +2 -2
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +10 -2
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +10 -2
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +4 -4
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +4 -4
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/feedback.mjs.map +1 -1
- package/resources/feedback/index.d.mts +2 -2
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +2 -2
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/post-statuses.d.mts +2 -2
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +2 -2
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +10 -2
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +10 -2
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +2 -2
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +2 -2
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/index.js.map +1 -1
- package/resources/feedback/posts/index.mjs.map +1 -1
- package/resources/feedback/posts/posts.d.mts +16 -61
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +16 -61
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +31 -7
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +31 -7
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +82 -127
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +82 -127
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/feedback/posts/voters.js +22 -6
- package/resources/feedback/posts/voters.js.map +1 -1
- package/resources/feedback/posts/voters.mjs +22 -6
- package/resources/feedback/posts/voters.mjs.map +1 -1
- package/resources/help-center/articles.d.mts +14 -32
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +14 -32
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +31 -7
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +31 -7
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +14 -33
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +14 -33
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +31 -8
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +31 -8
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +8 -8
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +8 -8
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-center.mjs.map +1 -1
- package/resources/help-center/help-centers.d.mts +11 -30
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +11 -30
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +16 -5
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +16 -5
- 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 +15 -34
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +15 -34
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +36 -9
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +36 -9
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/organization/admins.d.mts +3 -3
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +3 -3
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +15 -3
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +15 -3
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +7 -28
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +7 -28
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +12 -3
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +12 -3
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +1 -1
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +1 -1
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +2 -2
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +2 -2
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/organization.js.map +1 -1
- package/resources/organization/organization.mjs.map +1 -1
- package/resources/organization/teams.d.mts +2 -2
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +2 -2
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +10 -2
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +10 -2
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +4 -4
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +4 -4
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +20 -4
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +20 -4
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +17 -36
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +17 -36
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +41 -10
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +41 -10
- 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/conversations/participants.js +10 -2
- package/resources/support/conversations/participants.js.map +1 -1
- package/resources/support/conversations/participants.mjs +10 -2
- package/resources/support/conversations/participants.mjs.map +1 -1
- package/resources/support/conversations/tags.d.mts +2 -2
- package/resources/support/conversations/tags.d.mts.map +1 -1
- package/resources/support/conversations/tags.d.ts +2 -2
- package/resources/support/conversations/tags.d.ts.map +1 -1
- package/resources/support/conversations/tags.js +10 -2
- package/resources/support/conversations/tags.js.map +1 -1
- package/resources/support/conversations/tags.mjs +10 -2
- package/resources/support/conversations/tags.mjs.map +1 -1
- package/resources/support/index.d.mts +2 -2
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +2 -2
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +4 -4
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +4 -4
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/support.mjs.map +1 -1
- package/resources/support/tickets/categories.d.mts +2 -2
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +2 -2
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +10 -2
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +10 -2
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +2 -2
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +2 -2
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +10 -2
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +10 -2
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +1 -1
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +1 -1
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/statuses.d.mts +2 -2
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +2 -2
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +10 -2
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +10 -2
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +16 -34
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +16 -34
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +36 -8
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +36 -8
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +37 -82
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +37 -82
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +19 -6
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +19 -6
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +14 -33
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +14 -33
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +31 -7
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +31 -7
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +14 -19
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +14 -19
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/contacts.js +23 -8
- package/resources/users/companies/contacts.js.map +1 -1
- package/resources/users/companies/contacts.mjs +23 -8
- package/resources/users/companies/contacts.mjs.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/by-user-id.js +10 -2
- package/resources/users/contacts/by-user-id/by-user-id.js.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.mjs +10 -2
- package/resources/users/contacts/by-user-id/by-user-id.mjs.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/by-user-id/email-preferences.js +10 -2
- package/resources/users/contacts/by-user-id/email-preferences.js.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.mjs +10 -2
- package/resources/users/contacts/by-user-id/email-preferences.mjs.map +1 -1
- package/resources/users/contacts/contacts.d.mts +15 -19
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +15 -19
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +36 -8
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +36 -8
- 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/email-preferences.js +10 -2
- package/resources/users/contacts/email-preferences.js.map +1 -1
- package/resources/users/contacts/email-preferences.mjs +10 -2
- package/resources/users/contacts/email-preferences.mjs.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/contacts/index.js.map +1 -1
- package/resources/users/contacts/index.mjs.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/index.js.map +1 -1
- package/resources/users/index.mjs.map +1 -1
- package/resources/users/users.d.mts +4 -4
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +4 -4
- package/resources/users/users.d.ts.map +1 -1
- package/resources/users/users.js.map +1 -1
- package/resources/users/users.mjs.map +1 -1
- package/resources/webhooks.d.mts +15 -33
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +15 -33
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +36 -8
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +36 -8
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +41 -10
- package/src/core/pagination.ts +157 -0
- package/src/index.ts +1 -0
- package/src/pagination.ts +2 -0
- package/src/resources/changelogs/changelogs.ts +53 -78
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/changelogs/subscribers.ts +12 -4
- package/src/resources/feedback/boards.ts +12 -4
- package/src/resources/feedback/comments.ts +47 -76
- package/src/resources/feedback/custom-fields.ts +12 -4
- package/src/resources/feedback/feedback.ts +4 -4
- package/src/resources/feedback/index.ts +2 -2
- package/src/resources/feedback/post-statuses.ts +12 -4
- package/src/resources/feedback/posts/index.ts +2 -1
- package/src/resources/feedback/posts/posts.ts +43 -75
- package/src/resources/feedback/posts/voters.ts +105 -146
- package/src/resources/help-center/articles.ts +41 -43
- package/src/resources/help-center/collections.ts +41 -44
- package/src/resources/help-center/help-center.ts +8 -8
- package/src/resources/help-center/help-centers.ts +23 -38
- package/src/resources/help-center/index.ts +4 -4
- package/src/resources/help-center/redirect-rules.ts +47 -46
- package/src/resources/index.ts +6 -5
- package/src/resources/organization/admins.ts +18 -6
- package/src/resources/organization/brands.ts +19 -36
- package/src/resources/organization/index.ts +1 -1
- package/src/resources/organization/organization.ts +2 -2
- package/src/resources/organization/teams.ts +12 -4
- package/src/resources/support/conversation-tags.ts +24 -8
- package/src/resources/support/conversations/conversations.ts +54 -49
- package/src/resources/support/conversations/index.ts +1 -1
- package/src/resources/support/conversations/participants.ts +12 -4
- package/src/resources/support/conversations/tags.ts +12 -4
- package/src/resources/support/index.ts +2 -2
- package/src/resources/support/support.ts +4 -4
- package/src/resources/support/tickets/categories.ts +12 -4
- package/src/resources/support/tickets/custom-fields.ts +12 -4
- package/src/resources/support/tickets/index.ts +1 -1
- package/src/resources/support/tickets/statuses.ts +12 -4
- package/src/resources/support/tickets/tickets.ts +48 -46
- package/src/resources/surveys.ts +71 -107
- package/src/resources/users/companies/companies.ts +41 -44
- package/src/resources/users/companies/contacts.ts +41 -31
- package/src/resources/users/companies/index.ts +1 -1
- package/src/resources/users/contacts/by-user-id/by-user-id.ts +12 -4
- package/src/resources/users/contacts/by-user-id/email-preferences.ts +12 -4
- package/src/resources/users/contacts/contacts.ts +50 -27
- package/src/resources/users/contacts/email-preferences.ts +12 -4
- package/src/resources/users/contacts/index.ts +1 -0
- package/src/resources/users/index.ts +2 -1
- package/src/resources/users/users.ts +4 -2
- package/src/resources/webhooks.ts +47 -45
- 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
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import * as ArticlesAPI from "./articles.js";
|
|
3
|
-
import { Article, ArticleAuthor, ArticleCreateParams, ArticleDeleteParams, ArticleDeleteResponse, ArticleIconInputNova, ArticleListParams,
|
|
3
|
+
import { Article, ArticleAuthor, ArticleCreateParams, ArticleDeleteParams, ArticleDeleteResponse, ArticleIconInputNova, ArticleListParams, ArticleRetrieveParams, ArticleTranslation, ArticleTranslationInputNova, ArticleUpdateParams, Articles, ArticlesCursorPage } from "./articles.js";
|
|
4
4
|
import * as CollectionsAPI from "./collections.js";
|
|
5
|
-
import { Collection, CollectionCreateParams, CollectionDeleteParams, CollectionDeleteResponse, CollectionIconNova, CollectionListParams,
|
|
5
|
+
import { Collection, CollectionCreateParams, CollectionDeleteParams, CollectionDeleteResponse, CollectionIconNova, CollectionListParams, CollectionRetrieveParams, CollectionTranslation, CollectionTranslationInputNova, CollectionUpdateParams, Collections, CollectionsCursorPage } from "./collections.js";
|
|
6
6
|
import * as HelpCentersAPI from "./help-centers.js";
|
|
7
|
-
import { HelpCenter as HelpCentersAPIHelpCenter, HelpCenterListParams,
|
|
7
|
+
import { HelpCenter as HelpCentersAPIHelpCenter, HelpCenterListParams, HelpCenterNavItem, HelpCenterRetrieveParams, HelpCenterTranslation, HelpCenters, HelpCentersCursorPage } from "./help-centers.js";
|
|
8
8
|
import * as RedirectRulesAPI from "./redirect-rules.js";
|
|
9
|
-
import { RedirectRule, RedirectRuleCreateParams, RedirectRuleDeleteParams, RedirectRuleDeleteResponse, RedirectRuleListParams,
|
|
9
|
+
import { RedirectRule, RedirectRuleCreateParams, RedirectRuleDeleteParams, RedirectRuleDeleteResponse, RedirectRuleListParams, RedirectRuleRetrieveByURLParams, RedirectRuleRetrieveParams, RedirectRuleUpdateParams, RedirectRules, RedirectRulesCursorPage } from "./redirect-rules.js";
|
|
10
10
|
export declare class HelpCenter extends APIResource {
|
|
11
11
|
helpCenters: HelpCentersAPI.HelpCenters;
|
|
12
12
|
collections: CollectionsAPI.Collections;
|
|
@@ -14,9 +14,9 @@ export declare class HelpCenter extends APIResource {
|
|
|
14
14
|
redirectRules: RedirectRulesAPI.RedirectRules;
|
|
15
15
|
}
|
|
16
16
|
export declare namespace HelpCenter {
|
|
17
|
-
export { HelpCenters as HelpCenters, type HelpCentersAPIHelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type
|
|
18
|
-
export { Collections as Collections, type Collection as Collection, type CollectionIconNova as CollectionIconNova, type CollectionTranslation as CollectionTranslation, type CollectionTranslationInputNova as CollectionTranslationInputNova, type
|
|
19
|
-
export { Articles as Articles, type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type
|
|
20
|
-
export { RedirectRules as RedirectRules, type RedirectRule as RedirectRule, type
|
|
17
|
+
export { HelpCenters as HelpCenters, type HelpCentersAPIHelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
18
|
+
export { Collections as Collections, type Collection as Collection, type CollectionIconNova as CollectionIconNova, type CollectionTranslation as CollectionTranslation, type CollectionTranslationInputNova as CollectionTranslationInputNova, type CollectionDeleteResponse as CollectionDeleteResponse, type CollectionsCursorPage as CollectionsCursorPage, type CollectionCreateParams as CollectionCreateParams, type CollectionRetrieveParams as CollectionRetrieveParams, type CollectionUpdateParams as CollectionUpdateParams, type CollectionListParams as CollectionListParams, type CollectionDeleteParams as CollectionDeleteParams, };
|
|
19
|
+
export { Articles as Articles, type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type ArticleDeleteResponse as ArticleDeleteResponse, type ArticlesCursorPage as ArticlesCursorPage, type ArticleCreateParams as ArticleCreateParams, type ArticleRetrieveParams as ArticleRetrieveParams, type ArticleUpdateParams as ArticleUpdateParams, type ArticleListParams as ArticleListParams, type ArticleDeleteParams as ArticleDeleteParams, };
|
|
20
|
+
export { RedirectRules as RedirectRules, type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
|
|
21
21
|
}
|
|
22
22
|
//# sourceMappingURL=help-center.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-center.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,
|
|
1
|
+
{"version":3,"file":"help-center.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,2BAA2B,EAC3B,mBAAmB,EACnB,QAAQ,EACR,kBAAkB,EACnB;OACM,KAAK,cAAc;OACnB,EACL,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,8BAA8B,EAC9B,sBAAsB,EACtB,WAAW,EACX,qBAAqB,EACtB;OACM,KAAK,cAAc;OACnB,EACL,UAAU,IAAI,wBAAwB,EACtC,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,WAAW,EACX,qBAAqB,EACtB;OACM,KAAK,gBAAgB;OACrB,EACL,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,+BAA+B,EAC/B,0BAA0B,EAC1B,wBAAwB,EACxB,aAAa,EACb,uBAAuB,EACxB;AAED,qBAAa,UAAW,SAAQ,WAAW;IACzC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;CAClG;AAOD,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,wBAAwB,IAAI,UAAU,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-center.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,
|
|
1
|
+
{"version":3,"file":"help-center.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAYL,QAAQ,GAET;OACM,KAAK,cAAc;OACnB,EAWL,WAAW,GAEZ;OACM,KAAK,cAAc;OACnB,EAML,WAAW,GAEZ;OACM,KAAK,gBAAgB;OACrB,EASL,aAAa,GAEd;AAED,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnG,CAAC;CAAA;AAED,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;AACrC,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;AACrC,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC/B,UAAU,CAAC,aAAa,GAAG,aAAa,CAAC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import * as HelpCentersAPI from "./help-centers.mjs";
|
|
3
3
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
5
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
6
|
/**
|
|
6
7
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -79,12 +80,15 @@ export declare class HelpCenters extends APIResource {
|
|
|
79
80
|
*
|
|
80
81
|
* @example
|
|
81
82
|
* ```ts
|
|
82
|
-
*
|
|
83
|
-
*
|
|
83
|
+
* // Automatically fetches more pages as needed.
|
|
84
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
85
|
+
* // ...
|
|
86
|
+
* }
|
|
84
87
|
* ```
|
|
85
88
|
*/
|
|
86
|
-
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions):
|
|
89
|
+
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions): PagePromise<HelpCentersCursorPage, HelpCenter>;
|
|
87
90
|
}
|
|
91
|
+
export type HelpCentersCursorPage = CursorPage<HelpCenter>;
|
|
88
92
|
export interface HelpCenter {
|
|
89
93
|
/**
|
|
90
94
|
* Help center unique identifier
|
|
@@ -269,44 +273,21 @@ export interface HelpCenterTranslation {
|
|
|
269
273
|
*/
|
|
270
274
|
title?: string;
|
|
271
275
|
}
|
|
272
|
-
export interface HelpCenterListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of help centers
|
|
275
|
-
*/
|
|
276
|
-
data: Array<HelpCenter>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface HelpCenterRetrieveParams {
|
|
287
277
|
/**
|
|
288
278
|
* API version for this request. Defaults to your organization's configured API
|
|
289
279
|
* version if not specified.
|
|
290
280
|
*/
|
|
291
|
-
'Featurebase-Version'?:
|
|
281
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
292
282
|
}
|
|
293
|
-
export interface HelpCenterListParams {
|
|
294
|
-
/**
|
|
295
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
296
|
-
* previous response to fetch the next page.
|
|
297
|
-
*/
|
|
298
|
-
cursor?: string;
|
|
299
|
-
/**
|
|
300
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
301
|
-
*/
|
|
302
|
-
limit?: number;
|
|
283
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
303
284
|
/**
|
|
304
285
|
* Header param: API version for this request. Defaults to your organization's
|
|
305
286
|
* configured API version if not specified.
|
|
306
287
|
*/
|
|
307
|
-
'Featurebase-Version'?:
|
|
288
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
308
289
|
}
|
|
309
290
|
export declare namespace HelpCenters {
|
|
310
|
-
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type
|
|
291
|
+
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
311
292
|
}
|
|
312
293
|
//# sourceMappingURL=help-centers.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"help-centers.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAezB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,UAAU,CAAC;CAelD;AAED,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;AAE3D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CACnB,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,CACP,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EACT,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;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,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;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import * as HelpCentersAPI from "./help-centers.js";
|
|
3
3
|
import { APIPromise } from "../../core/api-promise.js";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
|
|
4
5
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
5
6
|
/**
|
|
6
7
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -79,12 +80,15 @@ export declare class HelpCenters extends APIResource {
|
|
|
79
80
|
*
|
|
80
81
|
* @example
|
|
81
82
|
* ```ts
|
|
82
|
-
*
|
|
83
|
-
*
|
|
83
|
+
* // Automatically fetches more pages as needed.
|
|
84
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
85
|
+
* // ...
|
|
86
|
+
* }
|
|
84
87
|
* ```
|
|
85
88
|
*/
|
|
86
|
-
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions):
|
|
89
|
+
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions): PagePromise<HelpCentersCursorPage, HelpCenter>;
|
|
87
90
|
}
|
|
91
|
+
export type HelpCentersCursorPage = CursorPage<HelpCenter>;
|
|
88
92
|
export interface HelpCenter {
|
|
89
93
|
/**
|
|
90
94
|
* Help center unique identifier
|
|
@@ -269,44 +273,21 @@ export interface HelpCenterTranslation {
|
|
|
269
273
|
*/
|
|
270
274
|
title?: string;
|
|
271
275
|
}
|
|
272
|
-
export interface HelpCenterListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of help centers
|
|
275
|
-
*/
|
|
276
|
-
data: Array<HelpCenter>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface HelpCenterRetrieveParams {
|
|
287
277
|
/**
|
|
288
278
|
* API version for this request. Defaults to your organization's configured API
|
|
289
279
|
* version if not specified.
|
|
290
280
|
*/
|
|
291
|
-
'Featurebase-Version'?:
|
|
281
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
292
282
|
}
|
|
293
|
-
export interface HelpCenterListParams {
|
|
294
|
-
/**
|
|
295
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
296
|
-
* previous response to fetch the next page.
|
|
297
|
-
*/
|
|
298
|
-
cursor?: string;
|
|
299
|
-
/**
|
|
300
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
301
|
-
*/
|
|
302
|
-
limit?: number;
|
|
283
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
303
284
|
/**
|
|
304
285
|
* Header param: API version for this request. Defaults to your organization's
|
|
305
286
|
* configured API version if not specified.
|
|
306
287
|
*/
|
|
307
|
-
'Featurebase-Version'?:
|
|
288
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
308
289
|
}
|
|
309
290
|
export declare namespace HelpCenters {
|
|
310
|
-
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type
|
|
291
|
+
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
311
292
|
}
|
|
312
293
|
//# sourceMappingURL=help-centers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"help-centers.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAezB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,UAAU,CAAC;CAelD;AAED,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;AAE3D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CACnB,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,CACP,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EACT,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;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,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;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.HelpCenters = void 0;
|
|
5
5
|
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
6
7
|
const headers_1 = require("../../internal/headers.js");
|
|
7
8
|
const path_1 = require("../../internal/utils/path.js");
|
|
8
9
|
/**
|
|
@@ -49,7 +50,11 @@ class HelpCenters extends resource_1.APIResource {
|
|
|
49
50
|
return this._client.get((0, path_1.path) `/v2/help_center/help_centers/${id}`, {
|
|
50
51
|
...options,
|
|
51
52
|
headers: (0, headers_1.buildHeaders)([
|
|
52
|
-
{
|
|
53
|
+
{
|
|
54
|
+
...(featurebaseVersion?.toString() != null ?
|
|
55
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
56
|
+
: undefined),
|
|
57
|
+
},
|
|
53
58
|
options?.headers,
|
|
54
59
|
]),
|
|
55
60
|
});
|
|
@@ -91,17 +96,23 @@ class HelpCenters extends resource_1.APIResource {
|
|
|
91
96
|
*
|
|
92
97
|
* @example
|
|
93
98
|
* ```ts
|
|
94
|
-
*
|
|
95
|
-
*
|
|
99
|
+
* // Automatically fetches more pages as needed.
|
|
100
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
101
|
+
* // ...
|
|
102
|
+
* }
|
|
96
103
|
* ```
|
|
97
104
|
*/
|
|
98
105
|
list(params = {}, options) {
|
|
99
106
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
100
|
-
return this._client.
|
|
107
|
+
return this._client.getAPIList('/v2/help_center/help_centers', (pagination_1.CursorPage), {
|
|
101
108
|
query,
|
|
102
109
|
...options,
|
|
103
110
|
headers: (0, headers_1.buildHeaders)([
|
|
104
|
-
{
|
|
111
|
+
{
|
|
112
|
+
...(featurebaseVersion?.toString() != null ?
|
|
113
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
114
|
+
: undefined),
|
|
115
|
+
},
|
|
105
116
|
options?.headers,
|
|
106
117
|
]),
|
|
107
118
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,
|
|
1
|
+
{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAA,uBAAsB,CAAA,EAAE;YACrF,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;AApHD,kCAoHC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../../core/pagination.mjs";
|
|
3
4
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
5
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
6
|
/**
|
|
@@ -46,7 +47,11 @@ export class HelpCenters extends APIResource {
|
|
|
46
47
|
return this._client.get(path `/v2/help_center/help_centers/${id}`, {
|
|
47
48
|
...options,
|
|
48
49
|
headers: buildHeaders([
|
|
49
|
-
{
|
|
50
|
+
{
|
|
51
|
+
...(featurebaseVersion?.toString() != null ?
|
|
52
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
53
|
+
: undefined),
|
|
54
|
+
},
|
|
50
55
|
options?.headers,
|
|
51
56
|
]),
|
|
52
57
|
});
|
|
@@ -88,17 +93,23 @@ export class HelpCenters extends APIResource {
|
|
|
88
93
|
*
|
|
89
94
|
* @example
|
|
90
95
|
* ```ts
|
|
91
|
-
*
|
|
92
|
-
*
|
|
96
|
+
* // Automatically fetches more pages as needed.
|
|
97
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
98
|
+
* // ...
|
|
99
|
+
* }
|
|
93
100
|
* ```
|
|
94
101
|
*/
|
|
95
102
|
list(params = {}, options) {
|
|
96
103
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
97
|
-
return this._client.
|
|
104
|
+
return this._client.getAPIList('/v2/help_center/help_centers', (CursorPage), {
|
|
98
105
|
query,
|
|
99
106
|
...options,
|
|
100
107
|
headers: buildHeaders([
|
|
101
|
-
{
|
|
108
|
+
{
|
|
109
|
+
...(featurebaseVersion?.toString() != null ?
|
|
110
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
111
|
+
: undefined),
|
|
112
|
+
},
|
|
102
113
|
options?.headers,
|
|
103
114
|
]),
|
|
104
115
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,
|
|
1
|
+
{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAClD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAA,UAAsB,CAAA,EAAE;YACrF,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"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type
|
|
2
|
-
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type
|
|
1
|
+
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type ArticleDeleteResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, type ArticlesCursorPage, } from "./articles.mjs";
|
|
2
|
+
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, type CollectionsCursorPage, } from "./collections.mjs";
|
|
3
3
|
export { HelpCenter } from "./help-center.mjs";
|
|
4
|
-
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type
|
|
5
|
-
export { RedirectRules, type RedirectRule, type
|
|
4
|
+
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterRetrieveParams, type HelpCenterListParams, type HelpCentersCursorPage, } from "./help-centers.mjs";
|
|
5
|
+
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, type RedirectRulesCursorPage, } from "./redirect-rules.mjs";
|
|
6
6
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,GAC7B"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type
|
|
2
|
-
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type
|
|
1
|
+
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type ArticleDeleteResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, type ArticlesCursorPage, } from "./articles.js";
|
|
2
|
+
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, type CollectionsCursorPage, } from "./collections.js";
|
|
3
3
|
export { HelpCenter } from "./help-center.js";
|
|
4
|
-
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type
|
|
5
|
-
export { RedirectRules, type RedirectRule, type
|
|
4
|
+
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterRetrieveParams, type HelpCenterListParams, type HelpCentersCursorPage, } from "./help-centers.js";
|
|
5
|
+
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, type RedirectRulesCursorPage, } from "./redirect-rules.js";
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,GAC7B"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
3
4
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
5
|
/**
|
|
5
6
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -157,11 +158,13 @@ export declare class RedirectRules extends APIResource {
|
|
|
157
158
|
*
|
|
158
159
|
* @example
|
|
159
160
|
* ```ts
|
|
160
|
-
*
|
|
161
|
-
*
|
|
161
|
+
* // Automatically fetches more pages as needed.
|
|
162
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
163
|
+
* // ...
|
|
164
|
+
* }
|
|
162
165
|
* ```
|
|
163
166
|
*/
|
|
164
|
-
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions):
|
|
167
|
+
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
165
168
|
/**
|
|
166
169
|
* Deletes an existing redirect rule. The associated Redis cache entry is also
|
|
167
170
|
* invalidated.
|
|
@@ -231,6 +234,7 @@ export declare class RedirectRules extends APIResource {
|
|
|
231
234
|
*/
|
|
232
235
|
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
233
236
|
}
|
|
237
|
+
export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
|
|
234
238
|
export interface RedirectRule {
|
|
235
239
|
/**
|
|
236
240
|
* Redirect rule unique identifier
|
|
@@ -269,20 +273,6 @@ export interface RedirectRule {
|
|
|
269
273
|
*/
|
|
270
274
|
updatedAt: string;
|
|
271
275
|
}
|
|
272
|
-
export interface RedirectRuleListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of redirect rules
|
|
275
|
-
*/
|
|
276
|
-
data: Array<RedirectRule>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page. Null if there are no more results.
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface RedirectRuleDeleteResponse {
|
|
287
277
|
/**
|
|
288
278
|
* Unique identifier of the deleted redirect rule
|
|
@@ -325,14 +315,14 @@ export interface RedirectRuleCreateParams {
|
|
|
325
315
|
* Header param: API version for this request. Defaults to your organization's
|
|
326
316
|
* configured API version if not specified.
|
|
327
317
|
*/
|
|
328
|
-
'Featurebase-Version'?:
|
|
318
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
329
319
|
}
|
|
330
320
|
export interface RedirectRuleRetrieveParams {
|
|
331
321
|
/**
|
|
332
322
|
* API version for this request. Defaults to your organization's configured API
|
|
333
323
|
* version if not specified.
|
|
334
324
|
*/
|
|
335
|
-
'Featurebase-Version'?:
|
|
325
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
336
326
|
}
|
|
337
327
|
export interface RedirectRuleUpdateParams {
|
|
338
328
|
/**
|
|
@@ -361,22 +351,13 @@ export interface RedirectRuleUpdateParams {
|
|
|
361
351
|
* Header param: API version for this request. Defaults to your organization's
|
|
362
352
|
* configured API version if not specified.
|
|
363
353
|
*/
|
|
364
|
-
'Featurebase-Version'?:
|
|
354
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
365
355
|
}
|
|
366
|
-
export interface RedirectRuleListParams {
|
|
367
|
-
/**
|
|
368
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
369
|
-
* previous response to fetch the next page.
|
|
370
|
-
*/
|
|
371
|
-
cursor?: string;
|
|
356
|
+
export interface RedirectRuleListParams extends CursorPageParams {
|
|
372
357
|
/**
|
|
373
358
|
* Query param: Filter redirect rules by help center ID
|
|
374
359
|
*/
|
|
375
360
|
helpCenterId?: string;
|
|
376
|
-
/**
|
|
377
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
378
|
-
*/
|
|
379
|
-
limit?: number;
|
|
380
361
|
/**
|
|
381
362
|
* Query param: Filter redirect rules by locale
|
|
382
363
|
*/
|
|
@@ -389,14 +370,14 @@ export interface RedirectRuleListParams {
|
|
|
389
370
|
* Header param: API version for this request. Defaults to your organization's
|
|
390
371
|
* configured API version if not specified.
|
|
391
372
|
*/
|
|
392
|
-
'Featurebase-Version'?:
|
|
373
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
393
374
|
}
|
|
394
375
|
export interface RedirectRuleDeleteParams {
|
|
395
376
|
/**
|
|
396
377
|
* API version for this request. Defaults to your organization's configured API
|
|
397
378
|
* version if not specified.
|
|
398
379
|
*/
|
|
399
|
-
'Featurebase-Version'?:
|
|
380
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
400
381
|
}
|
|
401
382
|
export interface RedirectRuleRetrieveByURLParams {
|
|
402
383
|
/**
|
|
@@ -409,9 +390,9 @@ export interface RedirectRuleRetrieveByURLParams {
|
|
|
409
390
|
* Header param: API version for this request. Defaults to your organization's
|
|
410
391
|
* configured API version if not specified.
|
|
411
392
|
*/
|
|
412
|
-
'Featurebase-Version'?:
|
|
393
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
413
394
|
}
|
|
414
395
|
export declare namespace RedirectRules {
|
|
415
|
-
export { type RedirectRule as RedirectRule, type
|
|
396
|
+
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
|
|
416
397
|
}
|
|
417
398
|
//# sourceMappingURL=redirect-rules.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirect-rules.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"redirect-rules.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAe3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgBxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAe3G;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EACF,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;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,EACF,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;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;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;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;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;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|