featurebase-node 0.13.0 → 0.14.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 +19 -0
- package/api-promise.d.mts +1 -0
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +1 -0
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +1 -0
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +9 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -3
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +1 -0
- package/error.d.mts.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.mjs +1 -0
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts.map +1 -1
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/index.d.mts +2 -2
- package/internal/qs/index.d.mts.map +1 -1
- package/internal/qs/index.d.ts +2 -2
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/index.mjs.map +1 -1
- package/internal/qs/stringify.d.mts.map +1 -1
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.d.mts.map +1 -1
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +6 -0
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +6 -0
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +16 -10
- package/pagination.d.mts +1 -0
- package/pagination.d.mts.map +1 -1
- package/pagination.d.ts +1 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.mjs +1 -0
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +1 -0
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +1 -0
- package/resource.d.ts.map +1 -1
- package/resource.mjs +1 -0
- package/resource.mjs.map +1 -1
- package/resources/changelogs/changelogs.d.mts +106 -106
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +106 -106
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +74 -74
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +74 -74
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/changelogs/index.mjs.map +1 -1
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/changelogs/subscribers.mjs.map +1 -1
- package/resources/changelogs.d.mts.map +1 -1
- package/resources/changelogs.d.ts.map +1 -1
- package/resources/changelogs.mjs.map +1 -1
- package/resources/conversation-attributes.d.mts +117 -0
- package/resources/conversation-attributes.d.mts.map +1 -0
- package/resources/conversation-attributes.d.ts +117 -0
- package/resources/conversation-attributes.d.ts.map +1 -0
- package/resources/conversation-attributes.js +61 -0
- package/resources/conversation-attributes.js.map +1 -0
- package/resources/conversation-attributes.mjs +57 -0
- package/resources/conversation-attributes.mjs.map +1 -0
- package/resources/feedback/boards.d.mts +17 -17
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +17 -17
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +20 -20
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +20 -20
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +129 -191
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +129 -191
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +93 -93
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +93 -93
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +34 -34
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +34 -34
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +36 -36
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +36 -36
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +7 -7
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +7 -7
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/feedback.js.map +1 -1
- package/resources/feedback/feedback.mjs.map +1 -1
- package/resources/feedback/index.d.mts +5 -5
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +5 -5
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/index.js.map +1 -1
- package/resources/feedback/index.mjs.map +1 -1
- package/resources/feedback/post-statuses.d.mts +18 -18
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +18 -18
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +23 -23
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +23 -23
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +1 -1
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +1 -1
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/index.js.map +1 -1
- package/resources/feedback/posts/index.mjs.map +1 -1
- package/resources/feedback/posts/posts.d.mts +187 -260
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +187 -260
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +75 -75
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +75 -75
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/feedback/posts/voters.mjs.map +1 -1
- package/resources/feedback/posts.d.mts.map +1 -1
- package/resources/feedback/posts.d.ts.map +1 -1
- package/resources/feedback/posts.mjs.map +1 -1
- package/resources/feedback.d.mts.map +1 -1
- package/resources/feedback.d.ts.map +1 -1
- package/resources/feedback.mjs.map +1 -1
- package/resources/help-center/articles.d.mts +98 -152
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +98 -152
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +73 -73
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +73 -73
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +64 -64
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +64 -64
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +65 -65
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +65 -65
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +5 -5
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +5 -5
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-center.js.map +1 -1
- package/resources/help-center/help-center.mjs.map +1 -1
- package/resources/help-center/help-centers.d.mts +43 -43
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +43 -43
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +43 -43
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +43 -43
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/index.js.map +1 -1
- package/resources/help-center/index.mjs.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +117 -117
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +117 -117
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +112 -112
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +112 -112
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/help-center.d.mts.map +1 -1
- package/resources/help-center.d.ts.map +1 -1
- package/resources/help-center.mjs.map +1 -1
- package/resources/index.d.mts +4 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/organization/admins.d.mts +23 -23
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +23 -23
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +25 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +25 -25
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +50 -50
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +50 -50
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +54 -54
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +54 -54
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +3 -3
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +3 -3
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/index.mjs.map +1 -1
- package/resources/organization/organization.d.mts +3 -3
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +3 -3
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/organization.mjs.map +1 -1
- package/resources/organization/teams.d.mts +45 -45
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +45 -45
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +44 -44
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +44 -44
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/organization.d.mts.map +1 -1
- package/resources/organization.d.ts.map +1 -1
- package/resources/organization.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +40 -40
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +40 -40
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +32 -32
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +32 -32
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +599 -705
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +599 -705
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +289 -288
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +289 -288
- 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/index.js.map +1 -1
- package/resources/support/conversations/index.mjs.map +1 -1
- package/resources/support/conversations/participants.d.mts.map +1 -1
- package/resources/support/conversations/participants.d.ts.map +1 -1
- package/resources/support/conversations/participants.mjs.map +1 -1
- package/resources/support/conversations.d.mts.map +1 -1
- package/resources/support/conversations.d.ts.map +1 -1
- package/resources/support/conversations.mjs.map +1 -1
- package/resources/support/index.d.mts +3 -3
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +3 -3
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/index.js.map +1 -1
- package/resources/support/index.mjs.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.js.map +1 -1
- package/resources/support/support.mjs.map +1 -1
- package/resources/support/tickets/categories.d.mts +18 -18
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +18 -18
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +25 -25
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +25 -25
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +20 -20
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +20 -20
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +19 -19
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +19 -19
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +4 -4
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +4 -4
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/index.mjs.map +1 -1
- package/resources/support/tickets/statuses.d.mts +17 -17
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +17 -17
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +21 -21
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +21 -21
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +69 -69
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +69 -69
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +44 -44
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +44 -44
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/support/tickets.d.mts.map +1 -1
- package/resources/support/tickets.d.ts.map +1 -1
- package/resources/support/tickets.mjs.map +1 -1
- package/resources/support.d.mts.map +1 -1
- package/resources/support.d.ts.map +1 -1
- package/resources/support.mjs.map +1 -1
- package/resources/surveys.d.mts +41 -41
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +41 -41
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +44 -44
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +44 -44
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +116 -157
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +116 -157
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +125 -125
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +125 -125
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts.map +1 -1
- 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/companies/index.mjs.map +1 -1
- package/resources/users/companies.d.mts.map +1 -1
- package/resources/users/companies.d.ts.map +1 -1
- package/resources/users/companies.mjs.map +1 -1
- 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.map +1 -1
- 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.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.mjs.map +1 -1
- package/resources/users/contacts/by-user-id/index.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/index.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/index.mjs.map +1 -1
- package/resources/users/contacts/by-user-id.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id.mjs.map +1 -1
- package/resources/users/contacts/contacts.d.mts +196 -235
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +196 -235
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +186 -184
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +186 -184
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/email-preferences.d.ts.map +1 -1
- 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.mjs.map +1 -1
- package/resources/users/contacts.d.mts.map +1 -1
- package/resources/users/contacts.d.ts.map +1 -1
- package/resources/users/contacts.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.mjs.map +1 -1
- package/resources/users/users.d.mts +2 -2
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +2 -2
- package/resources/users/users.d.ts.map +1 -1
- package/resources/users/users.mjs.map +1 -1
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts.map +1 -1
- package/resources/users.mjs.map +1 -1
- package/resources/webhooks.d.mts +75 -75
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +75 -75
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +77 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +77 -77
- package/resources/webhooks.mjs.map +1 -1
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +25 -3
- package/src/resources/changelogs/changelogs.ts +170 -170
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/conversation-attributes.ts +181 -0
- package/src/resources/feedback/boards.ts +28 -28
- package/src/resources/feedback/comments.ts +153 -226
- package/src/resources/feedback/custom-fields.ts +44 -44
- package/src/resources/feedback/feedback.ts +19 -5
- package/src/resources/feedback/index.ts +12 -5
- package/src/resources/feedback/post-statuses.ts +31 -31
- package/src/resources/feedback/posts/index.ts +7 -1
- package/src/resources/feedback/posts/posts.ts +230 -311
- package/src/resources/help-center/articles.ts +123 -186
- package/src/resources/help-center/collections.ts +84 -84
- package/src/resources/help-center/help-center.ts +7 -5
- package/src/resources/help-center/help-centers.ts +55 -55
- package/src/resources/help-center/index.ts +6 -5
- package/src/resources/help-center/redirect-rules.ts +174 -174
- package/src/resources/index.ts +11 -3
- package/src/resources/organization/admins.ts +33 -33
- package/src/resources/organization/brands.ts +66 -66
- package/src/resources/organization/index.ts +3 -3
- package/src/resources/organization/organization.ts +3 -3
- package/src/resources/organization/teams.ts +52 -52
- package/src/resources/support/conversation-tags.ts +59 -59
- package/src/resources/support/conversations/conversations.ts +723 -850
- package/src/resources/support/conversations/index.ts +11 -6
- package/src/resources/support/index.ts +14 -9
- package/src/resources/support/support.ts +21 -11
- package/src/resources/support/tickets/categories.ts +33 -33
- package/src/resources/support/tickets/custom-fields.ts +27 -27
- package/src/resources/support/tickets/index.ts +4 -4
- package/src/resources/support/tickets/statuses.ts +29 -29
- package/src/resources/support/tickets/tickets.ts +95 -95
- package/src/resources/surveys.ts +58 -58
- package/src/resources/users/companies/companies.ts +155 -204
- package/src/resources/users/companies/index.ts +2 -2
- package/src/resources/users/contacts/contacts.ts +235 -282
- package/src/resources/users/contacts/index.ts +3 -3
- package/src/resources/users/index.ts +5 -5
- package/src/resources/users/users.ts +5 -5
- package/src/resources/webhooks.ts +95 -95
- package/src/version.ts +1 -1
- package/uploads.d.mts +1 -0
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +1 -0
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +1 -0
- package/uploads.mjs.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -6,6 +6,51 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
6
6
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
7
7
|
*/
|
|
8
8
|
export declare class RedirectRules extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Returns a paginated list of redirect rules within your organization.
|
|
11
|
+
*
|
|
12
|
+
* Redirect rules map old Help Center URLs to new article or collection
|
|
13
|
+
* destinations, enabling seamless migration from legacy help center systems. Only
|
|
14
|
+
* Help Centers with a custom domain configured support redirect rules.
|
|
15
|
+
*
|
|
16
|
+
* ### Query Parameters
|
|
17
|
+
*
|
|
18
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
19
|
+
* - `cursor` - Cursor for pagination
|
|
20
|
+
* - `helpCenterId` - Filter by help center ID
|
|
21
|
+
* - `locale` - Filter by locale code
|
|
22
|
+
* - `targetType` - Filter by target type ("article" or "collection")
|
|
23
|
+
*
|
|
24
|
+
* ### Response Format
|
|
25
|
+
*
|
|
26
|
+
* Returns a list object with:
|
|
27
|
+
*
|
|
28
|
+
* - `object` - Always "list"
|
|
29
|
+
* - `data` - Array of redirect rule objects
|
|
30
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
31
|
+
*
|
|
32
|
+
* ### Redirect Rule Object
|
|
33
|
+
*
|
|
34
|
+
* Each redirect rule includes:
|
|
35
|
+
*
|
|
36
|
+
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
37
|
+
* - `helpCenterId` - Help center this rule belongs to
|
|
38
|
+
* - `locale` - Locale code used to resolve the target translation
|
|
39
|
+
* - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
|
|
40
|
+
* - `targetType` - "article" or "collection"
|
|
41
|
+
* - `targetId` - ID of the target article or collection
|
|
42
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
43
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* // Automatically fetches more pages as needed.
|
|
48
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
49
|
+
* // ...
|
|
50
|
+
* }
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
9
54
|
/**
|
|
10
55
|
* Creates a new redirect rule in your organization.
|
|
11
56
|
*
|
|
@@ -50,6 +95,45 @@ export declare class RedirectRules extends APIResource {
|
|
|
50
95
|
* ```
|
|
51
96
|
*/
|
|
52
97
|
create(params: RedirectRuleCreateParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
98
|
+
/**
|
|
99
|
+
* Retrieves a specific redirect rule by its source URL.
|
|
100
|
+
*
|
|
101
|
+
* The `url` query parameter is normalized before matching: query parameters and
|
|
102
|
+
* hash fragments are stripped, the hostname is lowercased, and trailing slashes
|
|
103
|
+
* are removed. This is the same normalization applied when creating a redirect
|
|
104
|
+
* rule.
|
|
105
|
+
*
|
|
106
|
+
* ### Query Parameters
|
|
107
|
+
*
|
|
108
|
+
* - `url` (required) - Full absolute URL to look up (http or https)
|
|
109
|
+
*
|
|
110
|
+
* ### Response
|
|
111
|
+
*
|
|
112
|
+
* Returns a redirect rule object with:
|
|
113
|
+
*
|
|
114
|
+
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
115
|
+
* - `helpCenterId` - Help center this rule belongs to
|
|
116
|
+
* - `locale` - Locale code
|
|
117
|
+
* - `fromUrl` - Canonical source URL being redirected from
|
|
118
|
+
* - `targetType` - "article" or "collection"
|
|
119
|
+
* - `targetId` - ID of the target article or collection
|
|
120
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
121
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
122
|
+
*
|
|
123
|
+
* ### Errors
|
|
124
|
+
*
|
|
125
|
+
* - `400` - Invalid URL format
|
|
126
|
+
* - `404` - No redirect rule exists for the given URL
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```ts
|
|
130
|
+
* const redirectRule =
|
|
131
|
+
* await client.helpCenter.redirectRules.retrieveByURL({
|
|
132
|
+
* url: 'https://help.example.com/en/old/getting-started',
|
|
133
|
+
* });
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
53
137
|
/**
|
|
54
138
|
* Retrieves a specific redirect rule by its unique identifier.
|
|
55
139
|
*
|
|
@@ -120,51 +204,6 @@ export declare class RedirectRules extends APIResource {
|
|
|
120
204
|
* ```
|
|
121
205
|
*/
|
|
122
206
|
update(id: string, params: RedirectRuleUpdateParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
123
|
-
/**
|
|
124
|
-
* Returns a paginated list of redirect rules within your organization.
|
|
125
|
-
*
|
|
126
|
-
* Redirect rules map old Help Center URLs to new article or collection
|
|
127
|
-
* destinations, enabling seamless migration from legacy help center systems. Only
|
|
128
|
-
* Help Centers with a custom domain configured support redirect rules.
|
|
129
|
-
*
|
|
130
|
-
* ### Query Parameters
|
|
131
|
-
*
|
|
132
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
133
|
-
* - `cursor` - Cursor for pagination
|
|
134
|
-
* - `helpCenterId` - Filter by help center ID
|
|
135
|
-
* - `locale` - Filter by locale code
|
|
136
|
-
* - `targetType` - Filter by target type ("article" or "collection")
|
|
137
|
-
*
|
|
138
|
-
* ### Response Format
|
|
139
|
-
*
|
|
140
|
-
* Returns a list object with:
|
|
141
|
-
*
|
|
142
|
-
* - `object` - Always "list"
|
|
143
|
-
* - `data` - Array of redirect rule objects
|
|
144
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
145
|
-
*
|
|
146
|
-
* ### Redirect Rule Object
|
|
147
|
-
*
|
|
148
|
-
* Each redirect rule includes:
|
|
149
|
-
*
|
|
150
|
-
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
151
|
-
* - `helpCenterId` - Help center this rule belongs to
|
|
152
|
-
* - `locale` - Locale code used to resolve the target translation
|
|
153
|
-
* - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
|
|
154
|
-
* - `targetType` - "article" or "collection"
|
|
155
|
-
* - `targetId` - ID of the target article or collection
|
|
156
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
157
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
158
|
-
*
|
|
159
|
-
* @example
|
|
160
|
-
* ```ts
|
|
161
|
-
* // Automatically fetches more pages as needed.
|
|
162
|
-
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
163
|
-
* // ...
|
|
164
|
-
* }
|
|
165
|
-
* ```
|
|
166
|
-
*/
|
|
167
|
-
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
168
207
|
/**
|
|
169
208
|
* Deletes an existing redirect rule. The associated Redis cache entry is also
|
|
170
209
|
* invalidated.
|
|
@@ -194,45 +233,6 @@ export declare class RedirectRules extends APIResource {
|
|
|
194
233
|
* ```
|
|
195
234
|
*/
|
|
196
235
|
delete(id: string, params?: RedirectRuleDeleteParams | null | undefined, options?: RequestOptions): APIPromise<RedirectRuleDeleteResponse>;
|
|
197
|
-
/**
|
|
198
|
-
* Retrieves a specific redirect rule by its source URL.
|
|
199
|
-
*
|
|
200
|
-
* The `url` query parameter is normalized before matching: query parameters and
|
|
201
|
-
* hash fragments are stripped, the hostname is lowercased, and trailing slashes
|
|
202
|
-
* are removed. This is the same normalization applied when creating a redirect
|
|
203
|
-
* rule.
|
|
204
|
-
*
|
|
205
|
-
* ### Query Parameters
|
|
206
|
-
*
|
|
207
|
-
* - `url` (required) - Full absolute URL to look up (http or https)
|
|
208
|
-
*
|
|
209
|
-
* ### Response
|
|
210
|
-
*
|
|
211
|
-
* Returns a redirect rule object with:
|
|
212
|
-
*
|
|
213
|
-
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
214
|
-
* - `helpCenterId` - Help center this rule belongs to
|
|
215
|
-
* - `locale` - Locale code
|
|
216
|
-
* - `fromUrl` - Canonical source URL being redirected from
|
|
217
|
-
* - `targetType` - "article" or "collection"
|
|
218
|
-
* - `targetId` - ID of the target article or collection
|
|
219
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
220
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
221
|
-
*
|
|
222
|
-
* ### Errors
|
|
223
|
-
*
|
|
224
|
-
* - `400` - Invalid URL format
|
|
225
|
-
* - `404` - No redirect rule exists for the given URL
|
|
226
|
-
*
|
|
227
|
-
* @example
|
|
228
|
-
* ```ts
|
|
229
|
-
* const redirectRule =
|
|
230
|
-
* await client.helpCenter.redirectRules.retrieveByURL({
|
|
231
|
-
* url: 'https://help.example.com/en/old/getting-started',
|
|
232
|
-
* });
|
|
233
|
-
* ```
|
|
234
|
-
*/
|
|
235
|
-
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
236
236
|
}
|
|
237
237
|
export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
|
|
238
238
|
export interface RedirectRule {
|
|
@@ -287,6 +287,25 @@ export interface RedirectRuleDeleteResponse {
|
|
|
287
287
|
*/
|
|
288
288
|
object: 'redirect_rule';
|
|
289
289
|
}
|
|
290
|
+
export interface RedirectRuleListParams extends CursorPageParams {
|
|
291
|
+
/**
|
|
292
|
+
* Query param: Filter redirect rules by help center ID
|
|
293
|
+
*/
|
|
294
|
+
helpCenterId?: string;
|
|
295
|
+
/**
|
|
296
|
+
* Query param: Filter redirect rules by locale
|
|
297
|
+
*/
|
|
298
|
+
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
299
|
+
/**
|
|
300
|
+
* Query param: Filter redirect rules by target type
|
|
301
|
+
*/
|
|
302
|
+
targetType?: 'article' | 'collection';
|
|
303
|
+
/**
|
|
304
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
305
|
+
* configured API version if not specified.
|
|
306
|
+
*/
|
|
307
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
308
|
+
}
|
|
290
309
|
export interface RedirectRuleCreateParams {
|
|
291
310
|
/**
|
|
292
311
|
* Body param: Full absolute URL to redirect from. Must use http or https protocol.
|
|
@@ -317,6 +336,19 @@ export interface RedirectRuleCreateParams {
|
|
|
317
336
|
*/
|
|
318
337
|
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
319
338
|
}
|
|
339
|
+
export interface RedirectRuleRetrieveByURLParams {
|
|
340
|
+
/**
|
|
341
|
+
* Query param: Full absolute URL to look up. The URL is normalized before
|
|
342
|
+
* matching: query parameters and hash fragments are stripped, the hostname is
|
|
343
|
+
* lowercased, and trailing slashes are removed.
|
|
344
|
+
*/
|
|
345
|
+
url: string;
|
|
346
|
+
/**
|
|
347
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
348
|
+
* configured API version if not specified.
|
|
349
|
+
*/
|
|
350
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
351
|
+
}
|
|
320
352
|
export interface RedirectRuleRetrieveParams {
|
|
321
353
|
/**
|
|
322
354
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -353,25 +385,6 @@ export interface RedirectRuleUpdateParams {
|
|
|
353
385
|
*/
|
|
354
386
|
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
355
387
|
}
|
|
356
|
-
export interface RedirectRuleListParams extends CursorPageParams {
|
|
357
|
-
/**
|
|
358
|
-
* Query param: Filter redirect rules by help center ID
|
|
359
|
-
*/
|
|
360
|
-
helpCenterId?: string;
|
|
361
|
-
/**
|
|
362
|
-
* Query param: Filter redirect rules by locale
|
|
363
|
-
*/
|
|
364
|
-
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
365
|
-
/**
|
|
366
|
-
* Query param: Filter redirect rules by target type
|
|
367
|
-
*/
|
|
368
|
-
targetType?: 'article' | 'collection';
|
|
369
|
-
/**
|
|
370
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
371
|
-
* configured API version if not specified.
|
|
372
|
-
*/
|
|
373
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
374
|
-
}
|
|
375
388
|
export interface RedirectRuleDeleteParams {
|
|
376
389
|
/**
|
|
377
390
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -379,20 +392,7 @@ export interface RedirectRuleDeleteParams {
|
|
|
379
392
|
*/
|
|
380
393
|
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
381
394
|
}
|
|
382
|
-
export interface RedirectRuleRetrieveByURLParams {
|
|
383
|
-
/**
|
|
384
|
-
* Query param: Full absolute URL to look up. The URL is normalized before
|
|
385
|
-
* matching: query parameters and hash fragments are stripped, the hostname is
|
|
386
|
-
* lowercased, and trailing slashes are removed.
|
|
387
|
-
*/
|
|
388
|
-
url: string;
|
|
389
|
-
/**
|
|
390
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
391
|
-
* configured API version if not specified.
|
|
392
|
-
*/
|
|
393
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
394
|
-
}
|
|
395
395
|
export declare namespace RedirectRules {
|
|
396
|
-
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type
|
|
396
|
+
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, };
|
|
397
397
|
}
|
|
398
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":"
|
|
1
|
+
{"version":3,"file":"redirect-rules.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,kCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB1G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;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;CAc1C;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,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;;;;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,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;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,wBAAwB;IACvC;;;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,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -6,6 +6,51 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
6
6
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
7
7
|
*/
|
|
8
8
|
export declare class RedirectRules extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Returns a paginated list of redirect rules within your organization.
|
|
11
|
+
*
|
|
12
|
+
* Redirect rules map old Help Center URLs to new article or collection
|
|
13
|
+
* destinations, enabling seamless migration from legacy help center systems. Only
|
|
14
|
+
* Help Centers with a custom domain configured support redirect rules.
|
|
15
|
+
*
|
|
16
|
+
* ### Query Parameters
|
|
17
|
+
*
|
|
18
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
19
|
+
* - `cursor` - Cursor for pagination
|
|
20
|
+
* - `helpCenterId` - Filter by help center ID
|
|
21
|
+
* - `locale` - Filter by locale code
|
|
22
|
+
* - `targetType` - Filter by target type ("article" or "collection")
|
|
23
|
+
*
|
|
24
|
+
* ### Response Format
|
|
25
|
+
*
|
|
26
|
+
* Returns a list object with:
|
|
27
|
+
*
|
|
28
|
+
* - `object` - Always "list"
|
|
29
|
+
* - `data` - Array of redirect rule objects
|
|
30
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
31
|
+
*
|
|
32
|
+
* ### Redirect Rule Object
|
|
33
|
+
*
|
|
34
|
+
* Each redirect rule includes:
|
|
35
|
+
*
|
|
36
|
+
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
37
|
+
* - `helpCenterId` - Help center this rule belongs to
|
|
38
|
+
* - `locale` - Locale code used to resolve the target translation
|
|
39
|
+
* - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
|
|
40
|
+
* - `targetType` - "article" or "collection"
|
|
41
|
+
* - `targetId` - ID of the target article or collection
|
|
42
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
43
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* // Automatically fetches more pages as needed.
|
|
48
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
49
|
+
* // ...
|
|
50
|
+
* }
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
9
54
|
/**
|
|
10
55
|
* Creates a new redirect rule in your organization.
|
|
11
56
|
*
|
|
@@ -50,6 +95,45 @@ export declare class RedirectRules extends APIResource {
|
|
|
50
95
|
* ```
|
|
51
96
|
*/
|
|
52
97
|
create(params: RedirectRuleCreateParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
98
|
+
/**
|
|
99
|
+
* Retrieves a specific redirect rule by its source URL.
|
|
100
|
+
*
|
|
101
|
+
* The `url` query parameter is normalized before matching: query parameters and
|
|
102
|
+
* hash fragments are stripped, the hostname is lowercased, and trailing slashes
|
|
103
|
+
* are removed. This is the same normalization applied when creating a redirect
|
|
104
|
+
* rule.
|
|
105
|
+
*
|
|
106
|
+
* ### Query Parameters
|
|
107
|
+
*
|
|
108
|
+
* - `url` (required) - Full absolute URL to look up (http or https)
|
|
109
|
+
*
|
|
110
|
+
* ### Response
|
|
111
|
+
*
|
|
112
|
+
* Returns a redirect rule object with:
|
|
113
|
+
*
|
|
114
|
+
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
115
|
+
* - `helpCenterId` - Help center this rule belongs to
|
|
116
|
+
* - `locale` - Locale code
|
|
117
|
+
* - `fromUrl` - Canonical source URL being redirected from
|
|
118
|
+
* - `targetType` - "article" or "collection"
|
|
119
|
+
* - `targetId` - ID of the target article or collection
|
|
120
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
121
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
122
|
+
*
|
|
123
|
+
* ### Errors
|
|
124
|
+
*
|
|
125
|
+
* - `400` - Invalid URL format
|
|
126
|
+
* - `404` - No redirect rule exists for the given URL
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```ts
|
|
130
|
+
* const redirectRule =
|
|
131
|
+
* await client.helpCenter.redirectRules.retrieveByURL({
|
|
132
|
+
* url: 'https://help.example.com/en/old/getting-started',
|
|
133
|
+
* });
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
53
137
|
/**
|
|
54
138
|
* Retrieves a specific redirect rule by its unique identifier.
|
|
55
139
|
*
|
|
@@ -120,51 +204,6 @@ export declare class RedirectRules extends APIResource {
|
|
|
120
204
|
* ```
|
|
121
205
|
*/
|
|
122
206
|
update(id: string, params: RedirectRuleUpdateParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
123
|
-
/**
|
|
124
|
-
* Returns a paginated list of redirect rules within your organization.
|
|
125
|
-
*
|
|
126
|
-
* Redirect rules map old Help Center URLs to new article or collection
|
|
127
|
-
* destinations, enabling seamless migration from legacy help center systems. Only
|
|
128
|
-
* Help Centers with a custom domain configured support redirect rules.
|
|
129
|
-
*
|
|
130
|
-
* ### Query Parameters
|
|
131
|
-
*
|
|
132
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
133
|
-
* - `cursor` - Cursor for pagination
|
|
134
|
-
* - `helpCenterId` - Filter by help center ID
|
|
135
|
-
* - `locale` - Filter by locale code
|
|
136
|
-
* - `targetType` - Filter by target type ("article" or "collection")
|
|
137
|
-
*
|
|
138
|
-
* ### Response Format
|
|
139
|
-
*
|
|
140
|
-
* Returns a list object with:
|
|
141
|
-
*
|
|
142
|
-
* - `object` - Always "list"
|
|
143
|
-
* - `data` - Array of redirect rule objects
|
|
144
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
145
|
-
*
|
|
146
|
-
* ### Redirect Rule Object
|
|
147
|
-
*
|
|
148
|
-
* Each redirect rule includes:
|
|
149
|
-
*
|
|
150
|
-
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
151
|
-
* - `helpCenterId` - Help center this rule belongs to
|
|
152
|
-
* - `locale` - Locale code used to resolve the target translation
|
|
153
|
-
* - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
|
|
154
|
-
* - `targetType` - "article" or "collection"
|
|
155
|
-
* - `targetId` - ID of the target article or collection
|
|
156
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
157
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
158
|
-
*
|
|
159
|
-
* @example
|
|
160
|
-
* ```ts
|
|
161
|
-
* // Automatically fetches more pages as needed.
|
|
162
|
-
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
163
|
-
* // ...
|
|
164
|
-
* }
|
|
165
|
-
* ```
|
|
166
|
-
*/
|
|
167
|
-
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
168
207
|
/**
|
|
169
208
|
* Deletes an existing redirect rule. The associated Redis cache entry is also
|
|
170
209
|
* invalidated.
|
|
@@ -194,45 +233,6 @@ export declare class RedirectRules extends APIResource {
|
|
|
194
233
|
* ```
|
|
195
234
|
*/
|
|
196
235
|
delete(id: string, params?: RedirectRuleDeleteParams | null | undefined, options?: RequestOptions): APIPromise<RedirectRuleDeleteResponse>;
|
|
197
|
-
/**
|
|
198
|
-
* Retrieves a specific redirect rule by its source URL.
|
|
199
|
-
*
|
|
200
|
-
* The `url` query parameter is normalized before matching: query parameters and
|
|
201
|
-
* hash fragments are stripped, the hostname is lowercased, and trailing slashes
|
|
202
|
-
* are removed. This is the same normalization applied when creating a redirect
|
|
203
|
-
* rule.
|
|
204
|
-
*
|
|
205
|
-
* ### Query Parameters
|
|
206
|
-
*
|
|
207
|
-
* - `url` (required) - Full absolute URL to look up (http or https)
|
|
208
|
-
*
|
|
209
|
-
* ### Response
|
|
210
|
-
*
|
|
211
|
-
* Returns a redirect rule object with:
|
|
212
|
-
*
|
|
213
|
-
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
214
|
-
* - `helpCenterId` - Help center this rule belongs to
|
|
215
|
-
* - `locale` - Locale code
|
|
216
|
-
* - `fromUrl` - Canonical source URL being redirected from
|
|
217
|
-
* - `targetType` - "article" or "collection"
|
|
218
|
-
* - `targetId` - ID of the target article or collection
|
|
219
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
220
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
221
|
-
*
|
|
222
|
-
* ### Errors
|
|
223
|
-
*
|
|
224
|
-
* - `400` - Invalid URL format
|
|
225
|
-
* - `404` - No redirect rule exists for the given URL
|
|
226
|
-
*
|
|
227
|
-
* @example
|
|
228
|
-
* ```ts
|
|
229
|
-
* const redirectRule =
|
|
230
|
-
* await client.helpCenter.redirectRules.retrieveByURL({
|
|
231
|
-
* url: 'https://help.example.com/en/old/getting-started',
|
|
232
|
-
* });
|
|
233
|
-
* ```
|
|
234
|
-
*/
|
|
235
|
-
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
236
236
|
}
|
|
237
237
|
export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
|
|
238
238
|
export interface RedirectRule {
|
|
@@ -287,6 +287,25 @@ export interface RedirectRuleDeleteResponse {
|
|
|
287
287
|
*/
|
|
288
288
|
object: 'redirect_rule';
|
|
289
289
|
}
|
|
290
|
+
export interface RedirectRuleListParams extends CursorPageParams {
|
|
291
|
+
/**
|
|
292
|
+
* Query param: Filter redirect rules by help center ID
|
|
293
|
+
*/
|
|
294
|
+
helpCenterId?: string;
|
|
295
|
+
/**
|
|
296
|
+
* Query param: Filter redirect rules by locale
|
|
297
|
+
*/
|
|
298
|
+
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
299
|
+
/**
|
|
300
|
+
* Query param: Filter redirect rules by target type
|
|
301
|
+
*/
|
|
302
|
+
targetType?: 'article' | 'collection';
|
|
303
|
+
/**
|
|
304
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
305
|
+
* configured API version if not specified.
|
|
306
|
+
*/
|
|
307
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
308
|
+
}
|
|
290
309
|
export interface RedirectRuleCreateParams {
|
|
291
310
|
/**
|
|
292
311
|
* Body param: Full absolute URL to redirect from. Must use http or https protocol.
|
|
@@ -317,6 +336,19 @@ export interface RedirectRuleCreateParams {
|
|
|
317
336
|
*/
|
|
318
337
|
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
319
338
|
}
|
|
339
|
+
export interface RedirectRuleRetrieveByURLParams {
|
|
340
|
+
/**
|
|
341
|
+
* Query param: Full absolute URL to look up. The URL is normalized before
|
|
342
|
+
* matching: query parameters and hash fragments are stripped, the hostname is
|
|
343
|
+
* lowercased, and trailing slashes are removed.
|
|
344
|
+
*/
|
|
345
|
+
url: string;
|
|
346
|
+
/**
|
|
347
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
348
|
+
* configured API version if not specified.
|
|
349
|
+
*/
|
|
350
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
351
|
+
}
|
|
320
352
|
export interface RedirectRuleRetrieveParams {
|
|
321
353
|
/**
|
|
322
354
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -353,25 +385,6 @@ export interface RedirectRuleUpdateParams {
|
|
|
353
385
|
*/
|
|
354
386
|
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
355
387
|
}
|
|
356
|
-
export interface RedirectRuleListParams extends CursorPageParams {
|
|
357
|
-
/**
|
|
358
|
-
* Query param: Filter redirect rules by help center ID
|
|
359
|
-
*/
|
|
360
|
-
helpCenterId?: string;
|
|
361
|
-
/**
|
|
362
|
-
* Query param: Filter redirect rules by locale
|
|
363
|
-
*/
|
|
364
|
-
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
365
|
-
/**
|
|
366
|
-
* Query param: Filter redirect rules by target type
|
|
367
|
-
*/
|
|
368
|
-
targetType?: 'article' | 'collection';
|
|
369
|
-
/**
|
|
370
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
371
|
-
* configured API version if not specified.
|
|
372
|
-
*/
|
|
373
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
374
|
-
}
|
|
375
388
|
export interface RedirectRuleDeleteParams {
|
|
376
389
|
/**
|
|
377
390
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -379,20 +392,7 @@ export interface RedirectRuleDeleteParams {
|
|
|
379
392
|
*/
|
|
380
393
|
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
381
394
|
}
|
|
382
|
-
export interface RedirectRuleRetrieveByURLParams {
|
|
383
|
-
/**
|
|
384
|
-
* Query param: Full absolute URL to look up. The URL is normalized before
|
|
385
|
-
* matching: query parameters and hash fragments are stripped, the hostname is
|
|
386
|
-
* lowercased, and trailing slashes are removed.
|
|
387
|
-
*/
|
|
388
|
-
url: string;
|
|
389
|
-
/**
|
|
390
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
391
|
-
* configured API version if not specified.
|
|
392
|
-
*/
|
|
393
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
394
|
-
}
|
|
395
395
|
export declare namespace RedirectRules {
|
|
396
|
-
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type
|
|
396
|
+
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, };
|
|
397
397
|
}
|
|
398
398
|
//# sourceMappingURL=redirect-rules.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirect-rules.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"redirect-rules.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,iCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAgB1G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;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;CAc1C;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,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;;;;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,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;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,wBAAwB;IACvC;;;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,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|