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
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
4
|
import * as CollectionsAPI from './collections';
|
|
5
5
|
import { APIPromise } from '../../core/api-promise';
|
|
6
|
+
import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
|
|
6
7
|
import { buildHeaders } from '../../internal/headers';
|
|
7
8
|
import { RequestOptions } from '../../internal/request-options';
|
|
8
9
|
import { path } from '../../internal/utils/path';
|
|
@@ -65,7 +66,11 @@ export class Collections extends APIResource {
|
|
|
65
66
|
body,
|
|
66
67
|
...options,
|
|
67
68
|
headers: buildHeaders([
|
|
68
|
-
{
|
|
69
|
+
{
|
|
70
|
+
...(featurebaseVersion?.toString() != null ?
|
|
71
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
72
|
+
: undefined),
|
|
73
|
+
},
|
|
69
74
|
options?.headers,
|
|
70
75
|
]),
|
|
71
76
|
});
|
|
@@ -119,7 +124,11 @@ export class Collections extends APIResource {
|
|
|
119
124
|
return this._client.get(path`/v2/help_center/collections/${id}`, {
|
|
120
125
|
...options,
|
|
121
126
|
headers: buildHeaders([
|
|
122
|
-
{
|
|
127
|
+
{
|
|
128
|
+
...(featurebaseVersion?.toString() != null ?
|
|
129
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
130
|
+
: undefined),
|
|
131
|
+
},
|
|
123
132
|
options?.headers,
|
|
124
133
|
]),
|
|
125
134
|
});
|
|
@@ -182,7 +191,11 @@ export class Collections extends APIResource {
|
|
|
182
191
|
body,
|
|
183
192
|
...options,
|
|
184
193
|
headers: buildHeaders([
|
|
185
|
-
{
|
|
194
|
+
{
|
|
195
|
+
...(featurebaseVersion?.toString() != null ?
|
|
196
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
197
|
+
: undefined),
|
|
198
|
+
},
|
|
186
199
|
options?.headers,
|
|
187
200
|
]),
|
|
188
201
|
});
|
|
@@ -232,20 +245,26 @@ export class Collections extends APIResource {
|
|
|
232
245
|
*
|
|
233
246
|
* @example
|
|
234
247
|
* ```ts
|
|
235
|
-
*
|
|
236
|
-
*
|
|
248
|
+
* // Automatically fetches more pages as needed.
|
|
249
|
+
* for await (const collection of client.helpCenter.collections.list()) {
|
|
250
|
+
* // ...
|
|
251
|
+
* }
|
|
237
252
|
* ```
|
|
238
253
|
*/
|
|
239
254
|
list(
|
|
240
255
|
params: CollectionListParams | null | undefined = {},
|
|
241
256
|
options?: RequestOptions,
|
|
242
|
-
):
|
|
257
|
+
): PagePromise<CollectionsCursorPage, Collection> {
|
|
243
258
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
244
|
-
return this._client.
|
|
259
|
+
return this._client.getAPIList('/v2/help_center/collections', CursorPage<Collection>, {
|
|
245
260
|
query,
|
|
246
261
|
...options,
|
|
247
262
|
headers: buildHeaders([
|
|
248
|
-
{
|
|
263
|
+
{
|
|
264
|
+
...(featurebaseVersion?.toString() != null ?
|
|
265
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
266
|
+
: undefined),
|
|
267
|
+
},
|
|
249
268
|
options?.headers,
|
|
250
269
|
]),
|
|
251
270
|
});
|
|
@@ -285,13 +304,19 @@ export class Collections extends APIResource {
|
|
|
285
304
|
return this._client.delete(path`/v2/help_center/collections/${id}`, {
|
|
286
305
|
...options,
|
|
287
306
|
headers: buildHeaders([
|
|
288
|
-
{
|
|
307
|
+
{
|
|
308
|
+
...(featurebaseVersion?.toString() != null ?
|
|
309
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
310
|
+
: undefined),
|
|
311
|
+
},
|
|
289
312
|
options?.headers,
|
|
290
313
|
]),
|
|
291
314
|
});
|
|
292
315
|
}
|
|
293
316
|
}
|
|
294
317
|
|
|
318
|
+
export type CollectionsCursorPage = CursorPage<Collection>;
|
|
319
|
+
|
|
295
320
|
export interface Collection {
|
|
296
321
|
/**
|
|
297
322
|
* Collection unique identifier
|
|
@@ -725,23 +750,6 @@ export interface CollectionTranslationInputNova {
|
|
|
725
750
|
name?: string;
|
|
726
751
|
}
|
|
727
752
|
|
|
728
|
-
export interface CollectionListResponse {
|
|
729
|
-
/**
|
|
730
|
-
* Array of collections
|
|
731
|
-
*/
|
|
732
|
-
data: Array<Collection>;
|
|
733
|
-
|
|
734
|
-
/**
|
|
735
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
736
|
-
*/
|
|
737
|
-
nextCursor: string | null;
|
|
738
|
-
|
|
739
|
-
/**
|
|
740
|
-
* Object type identifier
|
|
741
|
-
*/
|
|
742
|
-
object: 'list';
|
|
743
|
-
}
|
|
744
|
-
|
|
745
753
|
export interface CollectionDeleteResponse {
|
|
746
754
|
/**
|
|
747
755
|
* Unique identifier of the deleted collection
|
|
@@ -789,7 +797,7 @@ export interface CollectionCreateParams {
|
|
|
789
797
|
* Header param: API version for this request. Defaults to your organization's
|
|
790
798
|
* configured API version if not specified.
|
|
791
799
|
*/
|
|
792
|
-
'Featurebase-Version'?:
|
|
800
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
793
801
|
}
|
|
794
802
|
|
|
795
803
|
export namespace CollectionCreateParams {
|
|
@@ -888,7 +896,7 @@ export interface CollectionRetrieveParams {
|
|
|
888
896
|
* API version for this request. Defaults to your organization's configured API
|
|
889
897
|
* version if not specified.
|
|
890
898
|
*/
|
|
891
|
-
'Featurebase-Version'?:
|
|
899
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
892
900
|
}
|
|
893
901
|
|
|
894
902
|
export interface CollectionUpdateParams {
|
|
@@ -921,7 +929,7 @@ export interface CollectionUpdateParams {
|
|
|
921
929
|
* Header param: API version for this request. Defaults to your organization's
|
|
922
930
|
* configured API version if not specified.
|
|
923
931
|
*/
|
|
924
|
-
'Featurebase-Version'?:
|
|
932
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
925
933
|
}
|
|
926
934
|
|
|
927
935
|
export namespace CollectionUpdateParams {
|
|
@@ -1015,29 +1023,18 @@ export namespace CollectionUpdateParams {
|
|
|
1015
1023
|
}
|
|
1016
1024
|
}
|
|
1017
1025
|
|
|
1018
|
-
export interface CollectionListParams {
|
|
1019
|
-
/**
|
|
1020
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
1021
|
-
* previous response to fetch the next page.
|
|
1022
|
-
*/
|
|
1023
|
-
cursor?: string;
|
|
1024
|
-
|
|
1026
|
+
export interface CollectionListParams extends CursorPageParams {
|
|
1025
1027
|
/**
|
|
1026
1028
|
* Query param: Filter collections by help center ID. If omitted, returns
|
|
1027
1029
|
* collections across all help centers.
|
|
1028
1030
|
*/
|
|
1029
1031
|
helpCenterId?: string;
|
|
1030
1032
|
|
|
1031
|
-
/**
|
|
1032
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
1033
|
-
*/
|
|
1034
|
-
limit?: number;
|
|
1035
|
-
|
|
1036
1033
|
/**
|
|
1037
1034
|
* Header param: API version for this request. Defaults to your organization's
|
|
1038
1035
|
* configured API version if not specified.
|
|
1039
1036
|
*/
|
|
1040
|
-
'Featurebase-Version'?:
|
|
1037
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1041
1038
|
}
|
|
1042
1039
|
|
|
1043
1040
|
export interface CollectionDeleteParams {
|
|
@@ -1045,7 +1042,7 @@ export interface CollectionDeleteParams {
|
|
|
1045
1042
|
* API version for this request. Defaults to your organization's configured API
|
|
1046
1043
|
* version if not specified.
|
|
1047
1044
|
*/
|
|
1048
|
-
'Featurebase-Version'?:
|
|
1045
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1049
1046
|
}
|
|
1050
1047
|
|
|
1051
1048
|
export declare namespace Collections {
|
|
@@ -1054,8 +1051,8 @@ export declare namespace Collections {
|
|
|
1054
1051
|
type CollectionIconNova as CollectionIconNova,
|
|
1055
1052
|
type CollectionTranslation as CollectionTranslation,
|
|
1056
1053
|
type CollectionTranslationInputNova as CollectionTranslationInputNova,
|
|
1057
|
-
type CollectionListResponse as CollectionListResponse,
|
|
1058
1054
|
type CollectionDeleteResponse as CollectionDeleteResponse,
|
|
1055
|
+
type CollectionsCursorPage as CollectionsCursorPage,
|
|
1059
1056
|
type CollectionCreateParams as CollectionCreateParams,
|
|
1060
1057
|
type CollectionRetrieveParams as CollectionRetrieveParams,
|
|
1061
1058
|
type CollectionUpdateParams as CollectionUpdateParams,
|
|
@@ -10,12 +10,12 @@ import {
|
|
|
10
10
|
ArticleDeleteResponse,
|
|
11
11
|
ArticleIconInputNova,
|
|
12
12
|
ArticleListParams,
|
|
13
|
-
ArticleListResponse,
|
|
14
13
|
ArticleRetrieveParams,
|
|
15
14
|
ArticleTranslation,
|
|
16
15
|
ArticleTranslationInputNova,
|
|
17
16
|
ArticleUpdateParams,
|
|
18
17
|
Articles,
|
|
18
|
+
ArticlesCursorPage,
|
|
19
19
|
} from './articles';
|
|
20
20
|
import * as CollectionsAPI from './collections';
|
|
21
21
|
import {
|
|
@@ -25,22 +25,22 @@ import {
|
|
|
25
25
|
CollectionDeleteResponse,
|
|
26
26
|
CollectionIconNova,
|
|
27
27
|
CollectionListParams,
|
|
28
|
-
CollectionListResponse,
|
|
29
28
|
CollectionRetrieveParams,
|
|
30
29
|
CollectionTranslation,
|
|
31
30
|
CollectionTranslationInputNova,
|
|
32
31
|
CollectionUpdateParams,
|
|
33
32
|
Collections,
|
|
33
|
+
CollectionsCursorPage,
|
|
34
34
|
} from './collections';
|
|
35
35
|
import * as HelpCentersAPI from './help-centers';
|
|
36
36
|
import {
|
|
37
37
|
HelpCenter as HelpCentersAPIHelpCenter,
|
|
38
38
|
HelpCenterListParams,
|
|
39
|
-
HelpCenterListResponse,
|
|
40
39
|
HelpCenterNavItem,
|
|
41
40
|
HelpCenterRetrieveParams,
|
|
42
41
|
HelpCenterTranslation,
|
|
43
42
|
HelpCenters,
|
|
43
|
+
HelpCentersCursorPage,
|
|
44
44
|
} from './help-centers';
|
|
45
45
|
import * as RedirectRulesAPI from './redirect-rules';
|
|
46
46
|
import {
|
|
@@ -49,11 +49,11 @@ import {
|
|
|
49
49
|
RedirectRuleDeleteParams,
|
|
50
50
|
RedirectRuleDeleteResponse,
|
|
51
51
|
RedirectRuleListParams,
|
|
52
|
-
RedirectRuleListResponse,
|
|
53
52
|
RedirectRuleRetrieveByURLParams,
|
|
54
53
|
RedirectRuleRetrieveParams,
|
|
55
54
|
RedirectRuleUpdateParams,
|
|
56
55
|
RedirectRules,
|
|
56
|
+
RedirectRulesCursorPage,
|
|
57
57
|
} from './redirect-rules';
|
|
58
58
|
|
|
59
59
|
export class HelpCenter extends APIResource {
|
|
@@ -74,7 +74,7 @@ export declare namespace HelpCenter {
|
|
|
74
74
|
type HelpCentersAPIHelpCenter as HelpCenter,
|
|
75
75
|
type HelpCenterNavItem as HelpCenterNavItem,
|
|
76
76
|
type HelpCenterTranslation as HelpCenterTranslation,
|
|
77
|
-
type
|
|
77
|
+
type HelpCentersCursorPage as HelpCentersCursorPage,
|
|
78
78
|
type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
|
|
79
79
|
type HelpCenterListParams as HelpCenterListParams,
|
|
80
80
|
};
|
|
@@ -85,8 +85,8 @@ export declare namespace HelpCenter {
|
|
|
85
85
|
type CollectionIconNova as CollectionIconNova,
|
|
86
86
|
type CollectionTranslation as CollectionTranslation,
|
|
87
87
|
type CollectionTranslationInputNova as CollectionTranslationInputNova,
|
|
88
|
-
type CollectionListResponse as CollectionListResponse,
|
|
89
88
|
type CollectionDeleteResponse as CollectionDeleteResponse,
|
|
89
|
+
type CollectionsCursorPage as CollectionsCursorPage,
|
|
90
90
|
type CollectionCreateParams as CollectionCreateParams,
|
|
91
91
|
type CollectionRetrieveParams as CollectionRetrieveParams,
|
|
92
92
|
type CollectionUpdateParams as CollectionUpdateParams,
|
|
@@ -101,8 +101,8 @@ export declare namespace HelpCenter {
|
|
|
101
101
|
type ArticleIconInputNova as ArticleIconInputNova,
|
|
102
102
|
type ArticleTranslation as ArticleTranslation,
|
|
103
103
|
type ArticleTranslationInputNova as ArticleTranslationInputNova,
|
|
104
|
-
type ArticleListResponse as ArticleListResponse,
|
|
105
104
|
type ArticleDeleteResponse as ArticleDeleteResponse,
|
|
105
|
+
type ArticlesCursorPage as ArticlesCursorPage,
|
|
106
106
|
type ArticleCreateParams as ArticleCreateParams,
|
|
107
107
|
type ArticleRetrieveParams as ArticleRetrieveParams,
|
|
108
108
|
type ArticleUpdateParams as ArticleUpdateParams,
|
|
@@ -113,8 +113,8 @@ export declare namespace HelpCenter {
|
|
|
113
113
|
export {
|
|
114
114
|
RedirectRules as RedirectRules,
|
|
115
115
|
type RedirectRule as RedirectRule,
|
|
116
|
-
type RedirectRuleListResponse as RedirectRuleListResponse,
|
|
117
116
|
type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse,
|
|
117
|
+
type RedirectRulesCursorPage as RedirectRulesCursorPage,
|
|
118
118
|
type RedirectRuleCreateParams as RedirectRuleCreateParams,
|
|
119
119
|
type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams,
|
|
120
120
|
type RedirectRuleUpdateParams as RedirectRuleUpdateParams,
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
4
|
import * as HelpCentersAPI from './help-centers';
|
|
5
5
|
import { APIPromise } from '../../core/api-promise';
|
|
6
|
+
import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
|
|
6
7
|
import { buildHeaders } from '../../internal/headers';
|
|
7
8
|
import { RequestOptions } from '../../internal/request-options';
|
|
8
9
|
import { path } from '../../internal/utils/path';
|
|
@@ -55,7 +56,11 @@ export class HelpCenters extends APIResource {
|
|
|
55
56
|
return this._client.get(path`/v2/help_center/help_centers/${id}`, {
|
|
56
57
|
...options,
|
|
57
58
|
headers: buildHeaders([
|
|
58
|
-
{
|
|
59
|
+
{
|
|
60
|
+
...(featurebaseVersion?.toString() != null ?
|
|
61
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
62
|
+
: undefined),
|
|
63
|
+
},
|
|
59
64
|
options?.headers,
|
|
60
65
|
]),
|
|
61
66
|
});
|
|
@@ -98,26 +103,34 @@ export class HelpCenters extends APIResource {
|
|
|
98
103
|
*
|
|
99
104
|
* @example
|
|
100
105
|
* ```ts
|
|
101
|
-
*
|
|
102
|
-
*
|
|
106
|
+
* // Automatically fetches more pages as needed.
|
|
107
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
108
|
+
* // ...
|
|
109
|
+
* }
|
|
103
110
|
* ```
|
|
104
111
|
*/
|
|
105
112
|
list(
|
|
106
113
|
params: HelpCenterListParams | null | undefined = {},
|
|
107
114
|
options?: RequestOptions,
|
|
108
|
-
):
|
|
115
|
+
): PagePromise<HelpCentersCursorPage, HelpCenter> {
|
|
109
116
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
110
|
-
return this._client.
|
|
117
|
+
return this._client.getAPIList('/v2/help_center/help_centers', CursorPage<HelpCenter>, {
|
|
111
118
|
query,
|
|
112
119
|
...options,
|
|
113
120
|
headers: buildHeaders([
|
|
114
|
-
{
|
|
121
|
+
{
|
|
122
|
+
...(featurebaseVersion?.toString() != null ?
|
|
123
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
124
|
+
: undefined),
|
|
125
|
+
},
|
|
115
126
|
options?.headers,
|
|
116
127
|
]),
|
|
117
128
|
});
|
|
118
129
|
}
|
|
119
130
|
}
|
|
120
131
|
|
|
132
|
+
export type HelpCentersCursorPage = CursorPage<HelpCenter>;
|
|
133
|
+
|
|
121
134
|
export interface HelpCenter {
|
|
122
135
|
/**
|
|
123
136
|
* Help center unique identifier
|
|
@@ -502,48 +515,20 @@ export interface HelpCenterTranslation {
|
|
|
502
515
|
title?: string;
|
|
503
516
|
}
|
|
504
517
|
|
|
505
|
-
export interface HelpCenterListResponse {
|
|
506
|
-
/**
|
|
507
|
-
* Array of help centers
|
|
508
|
-
*/
|
|
509
|
-
data: Array<HelpCenter>;
|
|
510
|
-
|
|
511
|
-
/**
|
|
512
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
513
|
-
*/
|
|
514
|
-
nextCursor: string | null;
|
|
515
|
-
|
|
516
|
-
/**
|
|
517
|
-
* Object type identifier
|
|
518
|
-
*/
|
|
519
|
-
object: 'list';
|
|
520
|
-
}
|
|
521
|
-
|
|
522
518
|
export interface HelpCenterRetrieveParams {
|
|
523
519
|
/**
|
|
524
520
|
* API version for this request. Defaults to your organization's configured API
|
|
525
521
|
* version if not specified.
|
|
526
522
|
*/
|
|
527
|
-
'Featurebase-Version'?:
|
|
523
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
528
524
|
}
|
|
529
525
|
|
|
530
|
-
export interface HelpCenterListParams {
|
|
531
|
-
/**
|
|
532
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
533
|
-
* previous response to fetch the next page.
|
|
534
|
-
*/
|
|
535
|
-
cursor?: string;
|
|
536
|
-
|
|
537
|
-
/**
|
|
538
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
539
|
-
*/
|
|
540
|
-
limit?: number;
|
|
541
|
-
|
|
526
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
542
527
|
/**
|
|
543
528
|
* Header param: API version for this request. Defaults to your organization's
|
|
544
529
|
* configured API version if not specified.
|
|
545
530
|
*/
|
|
546
|
-
'Featurebase-Version'?:
|
|
531
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
547
532
|
}
|
|
548
533
|
|
|
549
534
|
export declare namespace HelpCenters {
|
|
@@ -551,7 +536,7 @@ export declare namespace HelpCenters {
|
|
|
551
536
|
type HelpCenter as HelpCenter,
|
|
552
537
|
type HelpCenterNavItem as HelpCenterNavItem,
|
|
553
538
|
type HelpCenterTranslation as HelpCenterTranslation,
|
|
554
|
-
type
|
|
539
|
+
type HelpCentersCursorPage as HelpCentersCursorPage,
|
|
555
540
|
type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
|
|
556
541
|
type HelpCenterListParams as HelpCenterListParams,
|
|
557
542
|
};
|
|
@@ -7,13 +7,13 @@ export {
|
|
|
7
7
|
type ArticleIconInputNova,
|
|
8
8
|
type ArticleTranslation,
|
|
9
9
|
type ArticleTranslationInputNova,
|
|
10
|
-
type ArticleListResponse,
|
|
11
10
|
type ArticleDeleteResponse,
|
|
12
11
|
type ArticleCreateParams,
|
|
13
12
|
type ArticleRetrieveParams,
|
|
14
13
|
type ArticleUpdateParams,
|
|
15
14
|
type ArticleListParams,
|
|
16
15
|
type ArticleDeleteParams,
|
|
16
|
+
type ArticlesCursorPage,
|
|
17
17
|
} from './articles';
|
|
18
18
|
export {
|
|
19
19
|
Collections,
|
|
@@ -21,27 +21,26 @@ export {
|
|
|
21
21
|
type CollectionIconNova,
|
|
22
22
|
type CollectionTranslation,
|
|
23
23
|
type CollectionTranslationInputNova,
|
|
24
|
-
type CollectionListResponse,
|
|
25
24
|
type CollectionDeleteResponse,
|
|
26
25
|
type CollectionCreateParams,
|
|
27
26
|
type CollectionRetrieveParams,
|
|
28
27
|
type CollectionUpdateParams,
|
|
29
28
|
type CollectionListParams,
|
|
30
29
|
type CollectionDeleteParams,
|
|
30
|
+
type CollectionsCursorPage,
|
|
31
31
|
} from './collections';
|
|
32
32
|
export { HelpCenter } from './help-center';
|
|
33
33
|
export {
|
|
34
34
|
HelpCenters,
|
|
35
35
|
type HelpCenterNavItem,
|
|
36
36
|
type HelpCenterTranslation,
|
|
37
|
-
type HelpCenterListResponse,
|
|
38
37
|
type HelpCenterRetrieveParams,
|
|
39
38
|
type HelpCenterListParams,
|
|
39
|
+
type HelpCentersCursorPage,
|
|
40
40
|
} from './help-centers';
|
|
41
41
|
export {
|
|
42
42
|
RedirectRules,
|
|
43
43
|
type RedirectRule,
|
|
44
|
-
type RedirectRuleListResponse,
|
|
45
44
|
type RedirectRuleDeleteResponse,
|
|
46
45
|
type RedirectRuleCreateParams,
|
|
47
46
|
type RedirectRuleRetrieveParams,
|
|
@@ -49,4 +48,5 @@ export {
|
|
|
49
48
|
type RedirectRuleListParams,
|
|
50
49
|
type RedirectRuleDeleteParams,
|
|
51
50
|
type RedirectRuleRetrieveByURLParams,
|
|
51
|
+
type RedirectRulesCursorPage,
|
|
52
52
|
} from './redirect-rules';
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
4
|
import { APIPromise } from '../../core/api-promise';
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
|
|
5
6
|
import { buildHeaders } from '../../internal/headers';
|
|
6
7
|
import { RequestOptions } from '../../internal/request-options';
|
|
7
8
|
import { path } from '../../internal/utils/path';
|
|
@@ -59,7 +60,11 @@ export class RedirectRules extends APIResource {
|
|
|
59
60
|
body,
|
|
60
61
|
...options,
|
|
61
62
|
headers: buildHeaders([
|
|
62
|
-
{
|
|
63
|
+
{
|
|
64
|
+
...(featurebaseVersion?.toString() != null ?
|
|
65
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
66
|
+
: undefined),
|
|
67
|
+
},
|
|
63
68
|
options?.headers,
|
|
64
69
|
]),
|
|
65
70
|
});
|
|
@@ -104,7 +109,11 @@ export class RedirectRules extends APIResource {
|
|
|
104
109
|
return this._client.get(path`/v2/help_center/redirect_rules/${id}`, {
|
|
105
110
|
...options,
|
|
106
111
|
headers: buildHeaders([
|
|
107
|
-
{
|
|
112
|
+
{
|
|
113
|
+
...(featurebaseVersion?.toString() != null ?
|
|
114
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
115
|
+
: undefined),
|
|
116
|
+
},
|
|
108
117
|
options?.headers,
|
|
109
118
|
]),
|
|
110
119
|
});
|
|
@@ -154,7 +163,11 @@ export class RedirectRules extends APIResource {
|
|
|
154
163
|
body,
|
|
155
164
|
...options,
|
|
156
165
|
headers: buildHeaders([
|
|
157
|
-
{
|
|
166
|
+
{
|
|
167
|
+
...(featurebaseVersion?.toString() != null ?
|
|
168
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
169
|
+
: undefined),
|
|
170
|
+
},
|
|
158
171
|
options?.headers,
|
|
159
172
|
]),
|
|
160
173
|
});
|
|
@@ -198,20 +211,26 @@ export class RedirectRules extends APIResource {
|
|
|
198
211
|
*
|
|
199
212
|
* @example
|
|
200
213
|
* ```ts
|
|
201
|
-
*
|
|
202
|
-
*
|
|
214
|
+
* // Automatically fetches more pages as needed.
|
|
215
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
216
|
+
* // ...
|
|
217
|
+
* }
|
|
203
218
|
* ```
|
|
204
219
|
*/
|
|
205
220
|
list(
|
|
206
221
|
params: RedirectRuleListParams | null | undefined = {},
|
|
207
222
|
options?: RequestOptions,
|
|
208
|
-
):
|
|
223
|
+
): PagePromise<RedirectRulesCursorPage, RedirectRule> {
|
|
209
224
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
210
|
-
return this._client.
|
|
225
|
+
return this._client.getAPIList('/v2/help_center/redirect_rules', CursorPage<RedirectRule>, {
|
|
211
226
|
query,
|
|
212
227
|
...options,
|
|
213
228
|
headers: buildHeaders([
|
|
214
|
-
{
|
|
229
|
+
{
|
|
230
|
+
...(featurebaseVersion?.toString() != null ?
|
|
231
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
232
|
+
: undefined),
|
|
233
|
+
},
|
|
215
234
|
options?.headers,
|
|
216
235
|
]),
|
|
217
236
|
});
|
|
@@ -254,7 +273,11 @@ export class RedirectRules extends APIResource {
|
|
|
254
273
|
return this._client.delete(path`/v2/help_center/redirect_rules/${id}`, {
|
|
255
274
|
...options,
|
|
256
275
|
headers: buildHeaders([
|
|
257
|
-
{
|
|
276
|
+
{
|
|
277
|
+
...(featurebaseVersion?.toString() != null ?
|
|
278
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
279
|
+
: undefined),
|
|
280
|
+
},
|
|
258
281
|
options?.headers,
|
|
259
282
|
]),
|
|
260
283
|
});
|
|
@@ -304,13 +327,19 @@ export class RedirectRules extends APIResource {
|
|
|
304
327
|
query,
|
|
305
328
|
...options,
|
|
306
329
|
headers: buildHeaders([
|
|
307
|
-
{
|
|
330
|
+
{
|
|
331
|
+
...(featurebaseVersion?.toString() != null ?
|
|
332
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
333
|
+
: undefined),
|
|
334
|
+
},
|
|
308
335
|
options?.headers,
|
|
309
336
|
]),
|
|
310
337
|
});
|
|
311
338
|
}
|
|
312
339
|
}
|
|
313
340
|
|
|
341
|
+
export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
|
|
342
|
+
|
|
314
343
|
export interface RedirectRule {
|
|
315
344
|
/**
|
|
316
345
|
* Redirect rule unique identifier
|
|
@@ -400,23 +429,6 @@ export interface RedirectRule {
|
|
|
400
429
|
updatedAt: string;
|
|
401
430
|
}
|
|
402
431
|
|
|
403
|
-
export interface RedirectRuleListResponse {
|
|
404
|
-
/**
|
|
405
|
-
* Array of redirect rules
|
|
406
|
-
*/
|
|
407
|
-
data: Array<RedirectRule>;
|
|
408
|
-
|
|
409
|
-
/**
|
|
410
|
-
* Cursor for fetching the next page. Null if there are no more results.
|
|
411
|
-
*/
|
|
412
|
-
nextCursor: string | null;
|
|
413
|
-
|
|
414
|
-
/**
|
|
415
|
-
* Object type identifier
|
|
416
|
-
*/
|
|
417
|
-
object: 'list';
|
|
418
|
-
}
|
|
419
|
-
|
|
420
432
|
export interface RedirectRuleDeleteResponse {
|
|
421
433
|
/**
|
|
422
434
|
* Unique identifier of the deleted redirect rule
|
|
@@ -509,7 +521,7 @@ export interface RedirectRuleCreateParams {
|
|
|
509
521
|
* Header param: API version for this request. Defaults to your organization's
|
|
510
522
|
* configured API version if not specified.
|
|
511
523
|
*/
|
|
512
|
-
'Featurebase-Version'?:
|
|
524
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
513
525
|
}
|
|
514
526
|
|
|
515
527
|
export interface RedirectRuleRetrieveParams {
|
|
@@ -517,7 +529,7 @@ export interface RedirectRuleRetrieveParams {
|
|
|
517
529
|
* API version for this request. Defaults to your organization's configured API
|
|
518
530
|
* version if not specified.
|
|
519
531
|
*/
|
|
520
|
-
'Featurebase-Version'?:
|
|
532
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
521
533
|
}
|
|
522
534
|
|
|
523
535
|
export interface RedirectRuleUpdateParams {
|
|
@@ -594,26 +606,15 @@ export interface RedirectRuleUpdateParams {
|
|
|
594
606
|
* Header param: API version for this request. Defaults to your organization's
|
|
595
607
|
* configured API version if not specified.
|
|
596
608
|
*/
|
|
597
|
-
'Featurebase-Version'?:
|
|
609
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
598
610
|
}
|
|
599
611
|
|
|
600
|
-
export interface RedirectRuleListParams {
|
|
601
|
-
/**
|
|
602
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
603
|
-
* previous response to fetch the next page.
|
|
604
|
-
*/
|
|
605
|
-
cursor?: string;
|
|
606
|
-
|
|
612
|
+
export interface RedirectRuleListParams extends CursorPageParams {
|
|
607
613
|
/**
|
|
608
614
|
* Query param: Filter redirect rules by help center ID
|
|
609
615
|
*/
|
|
610
616
|
helpCenterId?: string;
|
|
611
617
|
|
|
612
|
-
/**
|
|
613
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
614
|
-
*/
|
|
615
|
-
limit?: number;
|
|
616
|
-
|
|
617
618
|
/**
|
|
618
619
|
* Query param: Filter redirect rules by locale
|
|
619
620
|
*/
|
|
@@ -670,7 +671,7 @@ export interface RedirectRuleListParams {
|
|
|
670
671
|
* Header param: API version for this request. Defaults to your organization's
|
|
671
672
|
* configured API version if not specified.
|
|
672
673
|
*/
|
|
673
|
-
'Featurebase-Version'?:
|
|
674
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
674
675
|
}
|
|
675
676
|
|
|
676
677
|
export interface RedirectRuleDeleteParams {
|
|
@@ -678,7 +679,7 @@ export interface RedirectRuleDeleteParams {
|
|
|
678
679
|
* API version for this request. Defaults to your organization's configured API
|
|
679
680
|
* version if not specified.
|
|
680
681
|
*/
|
|
681
|
-
'Featurebase-Version'?:
|
|
682
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
682
683
|
}
|
|
683
684
|
|
|
684
685
|
export interface RedirectRuleRetrieveByURLParams {
|
|
@@ -693,14 +694,14 @@ export interface RedirectRuleRetrieveByURLParams {
|
|
|
693
694
|
* Header param: API version for this request. Defaults to your organization's
|
|
694
695
|
* configured API version if not specified.
|
|
695
696
|
*/
|
|
696
|
-
'Featurebase-Version'?:
|
|
697
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
697
698
|
}
|
|
698
699
|
|
|
699
700
|
export declare namespace RedirectRules {
|
|
700
701
|
export {
|
|
701
702
|
type RedirectRule as RedirectRule,
|
|
702
|
-
type RedirectRuleListResponse as RedirectRuleListResponse,
|
|
703
703
|
type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse,
|
|
704
|
+
type RedirectRulesCursorPage as RedirectRulesCursorPage,
|
|
704
705
|
type RedirectRuleCreateParams as RedirectRuleCreateParams,
|
|
705
706
|
type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams,
|
|
706
707
|
type RedirectRuleUpdateParams as RedirectRuleUpdateParams,
|