featurebase-node 0.2.0 → 0.4.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 +18 -0
- package/README.md +31 -0
- package/client.d.mts +25 -10
- package/client.d.mts.map +1 -1
- package/client.d.ts +25 -10
- package/client.d.ts.map +1 -1
- package/client.js +27 -8
- package/client.js.map +1 -1
- package/client.mjs +27 -8
- 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 +9 -53
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +9 -53
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +6 -2
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +6 -2
- 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/feedback/comments.d.mts +10 -54
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +10 -54
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +6 -2
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +6 -2
- package/resources/feedback/comments.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/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 +12 -57
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +12 -57
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +6 -2
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +6 -2
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +79 -124
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +79 -124
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/feedback/posts/voters.js +7 -3
- package/resources/feedback/posts/voters.js.map +1 -1
- package/resources/feedback/posts/voters.mjs +7 -3
- package/resources/feedback/posts/voters.mjs.map +1 -1
- package/resources/help-center/articles.d.mts +9 -27
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +9 -27
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +6 -2
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +6 -2
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +9 -28
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +9 -28
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +6 -3
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +6 -3
- 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 +9 -28
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +9 -28
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +6 -3
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +6 -3
- 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 +9 -28
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +9 -28
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +6 -3
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +6 -3
- package/resources/help-center/redirect-rules.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 +7 -5
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -2
- package/resources/index.mjs.map +1 -1
- package/resources/organization/brands.d.mts +5 -26
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +5 -26
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +2 -1
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +2 -1
- 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/{products → support}/conversation-tags.d.mts +4 -4
- package/resources/{products/conversation-tags.d.ts.map → support/conversation-tags.d.mts.map} +1 -1
- package/resources/{products → support}/conversation-tags.d.ts +4 -4
- package/resources/support/conversation-tags.d.ts.map +1 -0
- package/resources/{products → support}/conversation-tags.js +4 -4
- package/resources/support/conversation-tags.js.map +1 -0
- package/resources/{products → support}/conversation-tags.mjs +4 -4
- package/resources/support/conversation-tags.mjs.map +1 -0
- package/resources/{products → support}/conversations/conversations.d.mts +15 -34
- package/resources/support/conversations/conversations.d.mts.map +1 -0
- package/resources/{products → support}/conversations/conversations.d.ts +15 -34
- package/resources/support/conversations/conversations.d.ts.map +1 -0
- package/resources/{products → support}/conversations/conversations.js +12 -9
- package/resources/support/conversations/conversations.js.map +1 -0
- package/resources/{products → support}/conversations/conversations.mjs +12 -9
- package/resources/support/conversations/conversations.mjs.map +1 -0
- package/resources/{products → support}/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -0
- package/resources/{products → support}/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -0
- package/resources/support/conversations/index.js.map +1 -0
- package/resources/support/conversations/index.mjs.map +1 -0
- package/resources/{products → support}/conversations/participants.d.mts +2 -2
- package/resources/{products/conversations/participants.d.ts.map → support/conversations/participants.d.mts.map} +1 -1
- package/resources/{products → support}/conversations/participants.d.ts +2 -2
- package/resources/support/conversations/participants.d.ts.map +1 -0
- package/resources/{products → support}/conversations/participants.js +2 -2
- package/resources/support/conversations/participants.js.map +1 -0
- package/resources/{products → support}/conversations/participants.mjs +2 -2
- package/resources/support/conversations/participants.mjs.map +1 -0
- package/resources/{products → support}/conversations/tags.d.mts +2 -2
- package/resources/{products/conversations/tags.d.ts.map → support/conversations/tags.d.mts.map} +1 -1
- package/resources/{products → support}/conversations/tags.d.ts +2 -2
- package/resources/support/conversations/tags.d.ts.map +1 -0
- package/resources/{products → support}/conversations/tags.js +2 -2
- package/resources/support/conversations/tags.js.map +1 -0
- package/resources/{products → support}/conversations/tags.mjs +2 -2
- package/resources/support/conversations/tags.mjs.map +1 -0
- package/resources/support/conversations.d.mts.map +1 -0
- package/resources/support/conversations.d.ts.map +1 -0
- package/resources/support/conversations.js.map +1 -0
- package/resources/support/conversations.mjs.map +1 -0
- package/resources/support/index.d.mts +5 -0
- package/resources/support/index.d.mts.map +1 -0
- package/resources/support/index.d.ts +5 -0
- package/resources/support/index.d.ts.map +1 -0
- package/resources/{products → support}/index.js +3 -5
- package/resources/support/index.js.map +1 -0
- package/resources/{products → support}/index.mjs +1 -2
- package/resources/support/index.mjs.map +1 -0
- package/resources/support/support.d.mts +18 -0
- package/resources/support/support.d.mts.map +1 -0
- package/resources/support/support.d.ts +18 -0
- package/resources/support/support.d.ts.map +1 -0
- package/resources/{products/products.js → support/support.js} +7 -11
- package/resources/support/support.js.map +1 -0
- package/resources/{products/products.mjs → support/support.mjs} +5 -9
- package/resources/support/support.mjs.map +1 -0
- package/resources/{products → support}/tickets/categories.d.mts +2 -2
- package/resources/{products/tickets/categories.d.ts.map → support/tickets/categories.d.mts.map} +1 -1
- package/resources/{products → support}/tickets/categories.d.ts +2 -2
- package/resources/support/tickets/categories.d.ts.map +1 -0
- package/resources/{products → support}/tickets/categories.js +2 -2
- package/resources/support/tickets/categories.js.map +1 -0
- package/resources/{products → support}/tickets/categories.mjs +2 -2
- package/resources/support/tickets/categories.mjs.map +1 -0
- package/resources/{products → support}/tickets/custom-fields.d.mts +2 -2
- package/resources/{products/tickets/custom-fields.d.ts.map → support/tickets/custom-fields.d.mts.map} +1 -1
- package/resources/{products → support}/tickets/custom-fields.d.ts +2 -2
- package/resources/support/tickets/custom-fields.d.ts.map +1 -0
- package/resources/{products → support}/tickets/custom-fields.js +2 -2
- package/resources/support/tickets/custom-fields.js.map +1 -0
- package/resources/{products → support}/tickets/custom-fields.mjs +2 -2
- package/resources/support/tickets/custom-fields.mjs.map +1 -0
- package/resources/{products → support}/tickets/index.d.mts +1 -1
- package/resources/support/tickets/index.d.mts.map +1 -0
- package/resources/{products → support}/tickets/index.d.ts +1 -1
- package/resources/support/tickets/index.d.ts.map +1 -0
- package/resources/support/tickets/index.js.map +1 -0
- package/resources/support/tickets/index.mjs.map +1 -0
- package/resources/{products → support}/tickets/statuses.d.mts +2 -2
- package/resources/{products/tickets/statuses.d.ts.map → support/tickets/statuses.d.mts.map} +1 -1
- package/resources/{products → support}/tickets/statuses.d.ts +2 -2
- package/resources/support/tickets/statuses.d.ts.map +1 -0
- package/resources/{products → support}/tickets/statuses.js +2 -2
- package/resources/support/tickets/statuses.js.map +1 -0
- package/resources/{products → support}/tickets/statuses.mjs +2 -2
- package/resources/support/tickets/statuses.mjs.map +1 -0
- package/resources/{products → support}/tickets/tickets.d.mts +14 -31
- package/resources/support/tickets/tickets.d.mts.map +1 -0
- package/resources/{products → support}/tickets/tickets.d.ts +14 -31
- package/resources/support/tickets/tickets.d.ts.map +1 -0
- package/resources/{products → support}/tickets/tickets.js +11 -7
- package/resources/support/tickets/tickets.js.map +1 -0
- package/resources/{products → support}/tickets/tickets.mjs +11 -7
- package/resources/support/tickets/tickets.mjs.map +1 -0
- package/resources/support/tickets.d.mts.map +1 -0
- package/resources/support/tickets.d.ts.map +1 -0
- package/resources/support/tickets.js.map +1 -0
- package/resources/support/tickets.mjs.map +1 -0
- package/resources/support.d.mts +2 -0
- package/resources/support.d.mts.map +1 -0
- package/resources/support.d.ts +2 -0
- package/resources/support.d.ts.map +1 -0
- package/resources/{products.js → support.js} +2 -2
- package/resources/support.js.map +1 -0
- package/{src/resources/integrations.ts → resources/support.mjs} +2 -2
- package/resources/support.mjs.map +1 -0
- package/resources/{products/surveys.d.mts → surveys.d.mts} +38 -103
- package/resources/surveys.d.mts.map +1 -0
- package/resources/{products/surveys.d.ts → surveys.d.ts} +38 -103
- package/resources/surveys.d.ts.map +1 -0
- package/resources/{products/surveys.js → surveys.js} +7 -26
- package/resources/surveys.js.map +1 -0
- package/resources/{products/surveys.mjs → surveys.mjs} +7 -26
- package/resources/surveys.mjs.map +1 -0
- package/resources/users/companies/companies.d.mts +9 -28
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +9 -28
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +6 -2
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +6 -2
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +11 -16
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +11 -16
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/contacts.js +8 -5
- package/resources/users/companies/contacts.js.map +1 -1
- package/resources/users/companies/contacts.mjs +8 -5
- 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/contacts.d.mts +9 -13
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +9 -13
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +6 -2
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +6 -2
- package/resources/users/contacts/contacts.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/{integrations/webhooks.d.mts → webhooks.d.mts} +19 -38
- package/resources/webhooks.d.mts.map +1 -0
- package/resources/{integrations/webhooks.d.ts → webhooks.d.ts} +19 -38
- package/resources/webhooks.d.ts.map +1 -0
- package/resources/{integrations/webhooks.js → webhooks.js} +16 -13
- package/resources/webhooks.js.map +1 -0
- package/resources/{integrations/webhooks.mjs → webhooks.mjs} +16 -13
- package/resources/webhooks.mjs.map +1 -0
- package/src/client.ts +98 -14
- 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 +11 -64
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/feedback/comments.ts +12 -65
- package/src/resources/feedback/feedback.ts +4 -4
- package/src/resources/feedback/index.ts +2 -2
- package/src/resources/feedback/posts/index.ts +2 -1
- package/src/resources/feedback/posts/posts.ts +14 -66
- package/src/resources/feedback/posts/voters.ts +87 -140
- package/src/resources/help-center/articles.ts +11 -33
- package/src/resources/help-center/collections.ts +11 -34
- package/src/resources/help-center/help-center.ts +8 -8
- package/src/resources/help-center/help-centers.ts +11 -34
- package/src/resources/help-center/index.ts +4 -4
- package/src/resources/help-center/redirect-rules.ts +11 -34
- package/src/resources/index.ts +26 -3
- package/src/resources/organization/brands.ts +7 -32
- package/src/resources/organization/index.ts +1 -1
- package/src/resources/organization/organization.ts +2 -2
- package/src/resources/{products → support}/conversation-tags.ts +4 -4
- package/src/resources/{products → support}/conversations/conversations.ts +17 -40
- package/src/resources/{products → support}/conversations/index.ts +1 -1
- package/src/resources/{products → support}/conversations/participants.ts +2 -2
- package/src/resources/{products → support}/conversations/tags.ts +2 -2
- package/src/resources/{products → support}/index.ts +3 -13
- package/src/resources/{products/products.ts → support/support.ts} +9 -33
- package/src/resources/{products → support}/tickets/categories.ts +2 -2
- package/src/resources/{products → support}/tickets/custom-fields.ts +2 -2
- package/src/resources/{products → support}/tickets/index.ts +1 -1
- package/src/resources/{products → support}/tickets/statuses.ts +2 -2
- package/src/resources/{products → support}/tickets/tickets.ts +16 -37
- package/src/resources/{products.ts → support.ts} +1 -1
- package/src/resources/{products/surveys.ts → surveys.ts} +60 -128
- package/src/resources/users/companies/companies.ts +11 -34
- package/src/resources/users/companies/contacts.ts +24 -26
- package/src/resources/users/companies/index.ts +1 -1
- package/src/resources/users/contacts/contacts.ts +14 -15
- 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/{integrations/webhooks.ts → webhooks.ts} +23 -46
- 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
- package/resources/integrations/index.d.mts +0 -3
- package/resources/integrations/index.d.mts.map +0 -1
- package/resources/integrations/index.d.ts +0 -3
- package/resources/integrations/index.d.ts.map +0 -1
- package/resources/integrations/index.js +0 -9
- package/resources/integrations/index.js.map +0 -1
- package/resources/integrations/index.mjs +0 -4
- package/resources/integrations/index.mjs.map +0 -1
- package/resources/integrations/integrations.d.mts +0 -10
- package/resources/integrations/integrations.d.mts.map +0 -1
- package/resources/integrations/integrations.d.ts +0 -10
- package/resources/integrations/integrations.d.ts.map +0 -1
- package/resources/integrations/integrations.js +0 -17
- package/resources/integrations/integrations.js.map +0 -1
- package/resources/integrations/integrations.mjs +0 -12
- package/resources/integrations/integrations.mjs.map +0 -1
- package/resources/integrations/webhooks.d.mts.map +0 -1
- package/resources/integrations/webhooks.d.ts.map +0 -1
- package/resources/integrations/webhooks.js.map +0 -1
- package/resources/integrations/webhooks.mjs.map +0 -1
- package/resources/integrations.d.mts +0 -2
- package/resources/integrations.d.mts.map +0 -1
- package/resources/integrations.d.ts +0 -2
- package/resources/integrations.d.ts.map +0 -1
- package/resources/integrations.js +0 -6
- package/resources/integrations.js.map +0 -1
- package/resources/integrations.mjs +0 -3
- package/resources/integrations.mjs.map +0 -1
- package/resources/products/conversation-tags.d.mts.map +0 -1
- package/resources/products/conversation-tags.js.map +0 -1
- package/resources/products/conversation-tags.mjs.map +0 -1
- package/resources/products/conversations/conversations.d.mts.map +0 -1
- package/resources/products/conversations/conversations.d.ts.map +0 -1
- package/resources/products/conversations/conversations.js.map +0 -1
- package/resources/products/conversations/conversations.mjs.map +0 -1
- package/resources/products/conversations/index.d.mts.map +0 -1
- package/resources/products/conversations/index.d.ts.map +0 -1
- package/resources/products/conversations/index.js.map +0 -1
- package/resources/products/conversations/index.mjs.map +0 -1
- package/resources/products/conversations/participants.d.mts.map +0 -1
- package/resources/products/conversations/participants.js.map +0 -1
- package/resources/products/conversations/participants.mjs.map +0 -1
- package/resources/products/conversations/tags.d.mts.map +0 -1
- package/resources/products/conversations/tags.js.map +0 -1
- package/resources/products/conversations/tags.mjs.map +0 -1
- package/resources/products/conversations.d.mts.map +0 -1
- package/resources/products/conversations.d.ts.map +0 -1
- package/resources/products/conversations.js.map +0 -1
- package/resources/products/conversations.mjs.map +0 -1
- package/resources/products/index.d.mts +0 -6
- package/resources/products/index.d.mts.map +0 -1
- package/resources/products/index.d.ts +0 -6
- package/resources/products/index.d.ts.map +0 -1
- package/resources/products/index.js.map +0 -1
- package/resources/products/index.mjs.map +0 -1
- package/resources/products/products.d.mts +0 -22
- package/resources/products/products.d.mts.map +0 -1
- package/resources/products/products.d.ts +0 -22
- package/resources/products/products.d.ts.map +0 -1
- package/resources/products/products.js.map +0 -1
- package/resources/products/products.mjs.map +0 -1
- package/resources/products/surveys.d.mts.map +0 -1
- package/resources/products/surveys.d.ts.map +0 -1
- package/resources/products/surveys.js.map +0 -1
- package/resources/products/surveys.mjs.map +0 -1
- package/resources/products/tickets/categories.d.mts.map +0 -1
- package/resources/products/tickets/categories.js.map +0 -1
- package/resources/products/tickets/categories.mjs.map +0 -1
- package/resources/products/tickets/custom-fields.d.mts.map +0 -1
- package/resources/products/tickets/custom-fields.js.map +0 -1
- package/resources/products/tickets/custom-fields.mjs.map +0 -1
- package/resources/products/tickets/index.d.mts.map +0 -1
- package/resources/products/tickets/index.d.ts.map +0 -1
- package/resources/products/tickets/index.js.map +0 -1
- package/resources/products/tickets/index.mjs.map +0 -1
- package/resources/products/tickets/statuses.d.mts.map +0 -1
- package/resources/products/tickets/statuses.js.map +0 -1
- package/resources/products/tickets/statuses.mjs.map +0 -1
- package/resources/products/tickets/tickets.d.mts.map +0 -1
- package/resources/products/tickets/tickets.d.ts.map +0 -1
- package/resources/products/tickets/tickets.js.map +0 -1
- package/resources/products/tickets/tickets.mjs.map +0 -1
- package/resources/products/tickets.d.mts.map +0 -1
- package/resources/products/tickets.d.ts.map +0 -1
- package/resources/products/tickets.js.map +0 -1
- package/resources/products/tickets.mjs.map +0 -1
- package/resources/products.d.mts +0 -2
- package/resources/products.d.mts.map +0 -1
- package/resources/products.d.ts +0 -2
- package/resources/products.d.ts.map +0 -1
- package/resources/products.js.map +0 -1
- package/resources/products.mjs +0 -3
- package/resources/products.mjs.map +0 -1
- package/src/resources/integrations/index.ts +0 -16
- package/src/resources/integrations/integrations.ts +0 -39
- /package/resources/{products → support}/conversations/index.js +0 -0
- /package/resources/{products → support}/conversations/index.mjs +0 -0
- /package/resources/{products → support}/conversations.d.mts +0 -0
- /package/resources/{products → support}/conversations.d.ts +0 -0
- /package/resources/{products → support}/conversations.js +0 -0
- /package/resources/{products → support}/conversations.mjs +0 -0
- /package/resources/{products → support}/tickets/index.js +0 -0
- /package/resources/{products → support}/tickets/index.mjs +0 -0
- /package/resources/{products → support}/tickets.d.mts +0 -0
- /package/resources/{products → support}/tickets.d.ts +0 -0
- /package/resources/{products → support}/tickets.js +0 -0
- /package/resources/{products → support}/tickets.mjs +0 -0
- /package/src/resources/{products → support}/conversations.ts +0 -0
- /package/src/resources/{products → support}/tickets.ts +0 -0
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import * as HelpCentersAPI from "./help-centers.mjs";
|
|
3
3
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
5
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
6
|
/**
|
|
6
7
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -79,12 +80,15 @@ export declare class HelpCenters extends APIResource {
|
|
|
79
80
|
*
|
|
80
81
|
* @example
|
|
81
82
|
* ```ts
|
|
82
|
-
*
|
|
83
|
-
*
|
|
83
|
+
* // Automatically fetches more pages as needed.
|
|
84
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
85
|
+
* // ...
|
|
86
|
+
* }
|
|
84
87
|
* ```
|
|
85
88
|
*/
|
|
86
|
-
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions):
|
|
89
|
+
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions): PagePromise<HelpCentersCursorPage, HelpCenter>;
|
|
87
90
|
}
|
|
91
|
+
export type HelpCentersCursorPage = CursorPage<HelpCenter>;
|
|
88
92
|
export interface HelpCenter {
|
|
89
93
|
/**
|
|
90
94
|
* Help center unique identifier
|
|
@@ -269,20 +273,6 @@ export interface HelpCenterTranslation {
|
|
|
269
273
|
*/
|
|
270
274
|
title?: string;
|
|
271
275
|
}
|
|
272
|
-
export interface HelpCenterListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of help centers
|
|
275
|
-
*/
|
|
276
|
-
data: Array<HelpCenter>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface HelpCenterRetrieveParams {
|
|
287
277
|
/**
|
|
288
278
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -290,16 +280,7 @@ export interface HelpCenterRetrieveParams {
|
|
|
290
280
|
*/
|
|
291
281
|
'Featurebase-Version'?: string;
|
|
292
282
|
}
|
|
293
|
-
export interface HelpCenterListParams {
|
|
294
|
-
/**
|
|
295
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
296
|
-
* previous response to fetch the next page.
|
|
297
|
-
*/
|
|
298
|
-
cursor?: string;
|
|
299
|
-
/**
|
|
300
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
301
|
-
*/
|
|
302
|
-
limit?: number;
|
|
283
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
303
284
|
/**
|
|
304
285
|
* Header param: API version for this request. Defaults to your organization's
|
|
305
286
|
* configured API version if not specified.
|
|
@@ -307,6 +288,6 @@ export interface HelpCenterListParams {
|
|
|
307
288
|
'Featurebase-Version'?: string;
|
|
308
289
|
}
|
|
309
290
|
export declare namespace HelpCenters {
|
|
310
|
-
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type
|
|
291
|
+
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
311
292
|
}
|
|
312
293
|
//# sourceMappingURL=help-centers.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"help-centers.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,UAAU,CAAC;CAWlD;AAED,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;AAE3D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CACnB,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CACP,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EACT,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import * as HelpCentersAPI from "./help-centers.js";
|
|
3
3
|
import { APIPromise } from "../../core/api-promise.js";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
|
|
4
5
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
5
6
|
/**
|
|
6
7
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -79,12 +80,15 @@ export declare class HelpCenters extends APIResource {
|
|
|
79
80
|
*
|
|
80
81
|
* @example
|
|
81
82
|
* ```ts
|
|
82
|
-
*
|
|
83
|
-
*
|
|
83
|
+
* // Automatically fetches more pages as needed.
|
|
84
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
85
|
+
* // ...
|
|
86
|
+
* }
|
|
84
87
|
* ```
|
|
85
88
|
*/
|
|
86
|
-
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions):
|
|
89
|
+
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions): PagePromise<HelpCentersCursorPage, HelpCenter>;
|
|
87
90
|
}
|
|
91
|
+
export type HelpCentersCursorPage = CursorPage<HelpCenter>;
|
|
88
92
|
export interface HelpCenter {
|
|
89
93
|
/**
|
|
90
94
|
* Help center unique identifier
|
|
@@ -269,20 +273,6 @@ export interface HelpCenterTranslation {
|
|
|
269
273
|
*/
|
|
270
274
|
title?: string;
|
|
271
275
|
}
|
|
272
|
-
export interface HelpCenterListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of help centers
|
|
275
|
-
*/
|
|
276
|
-
data: Array<HelpCenter>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page (cursor-based pagination)
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface HelpCenterRetrieveParams {
|
|
287
277
|
/**
|
|
288
278
|
* API version for this request. Defaults to your organization's configured API
|
|
@@ -290,16 +280,7 @@ export interface HelpCenterRetrieveParams {
|
|
|
290
280
|
*/
|
|
291
281
|
'Featurebase-Version'?: string;
|
|
292
282
|
}
|
|
293
|
-
export interface HelpCenterListParams {
|
|
294
|
-
/**
|
|
295
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
296
|
-
* previous response to fetch the next page.
|
|
297
|
-
*/
|
|
298
|
-
cursor?: string;
|
|
299
|
-
/**
|
|
300
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
301
|
-
*/
|
|
302
|
-
limit?: number;
|
|
283
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
303
284
|
/**
|
|
304
285
|
* Header param: API version for this request. Defaults to your organization's
|
|
305
286
|
* configured API version if not specified.
|
|
@@ -307,6 +288,6 @@ export interface HelpCenterListParams {
|
|
|
307
288
|
'Featurebase-Version'?: string;
|
|
308
289
|
}
|
|
309
290
|
export declare namespace HelpCenters {
|
|
310
|
-
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type
|
|
291
|
+
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
311
292
|
}
|
|
312
293
|
//# sourceMappingURL=help-centers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"help-centers.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,UAAU,CAAC;CAWlD;AAED,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;AAE3D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CACnB,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CACP,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EACT,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.HelpCenters = void 0;
|
|
5
5
|
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
6
7
|
const headers_1 = require("../../internal/headers.js");
|
|
7
8
|
const path_1 = require("../../internal/utils/path.js");
|
|
8
9
|
/**
|
|
@@ -91,13 +92,15 @@ class HelpCenters extends resource_1.APIResource {
|
|
|
91
92
|
*
|
|
92
93
|
* @example
|
|
93
94
|
* ```ts
|
|
94
|
-
*
|
|
95
|
-
*
|
|
95
|
+
* // Automatically fetches more pages as needed.
|
|
96
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
97
|
+
* // ...
|
|
98
|
+
* }
|
|
96
99
|
* ```
|
|
97
100
|
*/
|
|
98
101
|
list(params = {}, options) {
|
|
99
102
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
100
|
-
return this._client.
|
|
103
|
+
return this._client.getAPIList('/v2/help_center/help_centers', (pagination_1.CursorPage), {
|
|
101
104
|
query,
|
|
102
105
|
...options,
|
|
103
106
|
headers: (0, headers_1.buildHeaders)([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAA,uBAAsB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA5GD,kCA4GC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../../core/pagination.mjs";
|
|
3
4
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
5
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
6
|
/**
|
|
@@ -88,13 +89,15 @@ export class HelpCenters extends APIResource {
|
|
|
88
89
|
*
|
|
89
90
|
* @example
|
|
90
91
|
* ```ts
|
|
91
|
-
*
|
|
92
|
-
*
|
|
92
|
+
* // Automatically fetches more pages as needed.
|
|
93
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
94
|
+
* // ...
|
|
95
|
+
* }
|
|
93
96
|
* ```
|
|
94
97
|
*/
|
|
95
98
|
list(params = {}, options) {
|
|
96
99
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
97
|
-
return this._client.
|
|
100
|
+
return this._client.getAPIList('/v2/help_center/help_centers', (CursorPage), {
|
|
98
101
|
query,
|
|
99
102
|
...options,
|
|
100
103
|
headers: buildHeaders([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAClD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAA,UAAsB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type
|
|
2
|
-
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type
|
|
1
|
+
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type ArticleDeleteResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, type ArticlesCursorPage, } from "./articles.mjs";
|
|
2
|
+
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, type CollectionsCursorPage, } from "./collections.mjs";
|
|
3
3
|
export { HelpCenter } from "./help-center.mjs";
|
|
4
|
-
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type
|
|
5
|
-
export { RedirectRules, type RedirectRule, type
|
|
4
|
+
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterRetrieveParams, type HelpCenterListParams, type HelpCentersCursorPage, } from "./help-centers.mjs";
|
|
5
|
+
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, type RedirectRulesCursorPage, } from "./redirect-rules.mjs";
|
|
6
6
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,GAC7B"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type
|
|
2
|
-
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type
|
|
1
|
+
export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type ArticleDeleteResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, type ArticlesCursorPage, } from "./articles.js";
|
|
2
|
+
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, type CollectionsCursorPage, } from "./collections.js";
|
|
3
3
|
export { HelpCenter } from "./help-center.js";
|
|
4
|
-
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type
|
|
5
|
-
export { RedirectRules, type RedirectRule, type
|
|
4
|
+
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterRetrieveParams, type HelpCenterListParams, type HelpCentersCursorPage, } from "./help-centers.js";
|
|
5
|
+
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, type RedirectRulesCursorPage, } from "./redirect-rules.js";
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,GAC7B"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
3
4
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
5
|
/**
|
|
5
6
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -157,11 +158,13 @@ export declare class RedirectRules extends APIResource {
|
|
|
157
158
|
*
|
|
158
159
|
* @example
|
|
159
160
|
* ```ts
|
|
160
|
-
*
|
|
161
|
-
*
|
|
161
|
+
* // Automatically fetches more pages as needed.
|
|
162
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
163
|
+
* // ...
|
|
164
|
+
* }
|
|
162
165
|
* ```
|
|
163
166
|
*/
|
|
164
|
-
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions):
|
|
167
|
+
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
165
168
|
/**
|
|
166
169
|
* Deletes an existing redirect rule. The associated Redis cache entry is also
|
|
167
170
|
* invalidated.
|
|
@@ -231,6 +234,7 @@ export declare class RedirectRules extends APIResource {
|
|
|
231
234
|
*/
|
|
232
235
|
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
233
236
|
}
|
|
237
|
+
export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
|
|
234
238
|
export interface RedirectRule {
|
|
235
239
|
/**
|
|
236
240
|
* Redirect rule unique identifier
|
|
@@ -269,20 +273,6 @@ export interface RedirectRule {
|
|
|
269
273
|
*/
|
|
270
274
|
updatedAt: string;
|
|
271
275
|
}
|
|
272
|
-
export interface RedirectRuleListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of redirect rules
|
|
275
|
-
*/
|
|
276
|
-
data: Array<RedirectRule>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page. Null if there are no more results.
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface RedirectRuleDeleteResponse {
|
|
287
277
|
/**
|
|
288
278
|
* Unique identifier of the deleted redirect rule
|
|
@@ -363,20 +353,11 @@ export interface RedirectRuleUpdateParams {
|
|
|
363
353
|
*/
|
|
364
354
|
'Featurebase-Version'?: string;
|
|
365
355
|
}
|
|
366
|
-
export interface RedirectRuleListParams {
|
|
367
|
-
/**
|
|
368
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
369
|
-
* previous response to fetch the next page.
|
|
370
|
-
*/
|
|
371
|
-
cursor?: string;
|
|
356
|
+
export interface RedirectRuleListParams extends CursorPageParams {
|
|
372
357
|
/**
|
|
373
358
|
* Query param: Filter redirect rules by help center ID
|
|
374
359
|
*/
|
|
375
360
|
helpCenterId?: string;
|
|
376
|
-
/**
|
|
377
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
378
|
-
*/
|
|
379
|
-
limit?: number;
|
|
380
361
|
/**
|
|
381
362
|
* Query param: Filter redirect rules by locale
|
|
382
363
|
*/
|
|
@@ -412,6 +393,6 @@ export interface RedirectRuleRetrieveByURLParams {
|
|
|
412
393
|
'Featurebase-Version'?: string;
|
|
413
394
|
}
|
|
414
395
|
export declare namespace RedirectRules {
|
|
415
|
-
export { type RedirectRule as RedirectRule, type
|
|
396
|
+
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
|
|
416
397
|
}
|
|
417
398
|
//# sourceMappingURL=redirect-rules.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirect-rules.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"redirect-rules.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAY5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAW3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAYxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAYrD;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAWzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAW3G;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;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,MAAM,CAAC;CAChC;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,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
|
|
3
4
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
5
|
/**
|
|
5
6
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
@@ -157,11 +158,13 @@ export declare class RedirectRules extends APIResource {
|
|
|
157
158
|
*
|
|
158
159
|
* @example
|
|
159
160
|
* ```ts
|
|
160
|
-
*
|
|
161
|
-
*
|
|
161
|
+
* // Automatically fetches more pages as needed.
|
|
162
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
163
|
+
* // ...
|
|
164
|
+
* }
|
|
162
165
|
* ```
|
|
163
166
|
*/
|
|
164
|
-
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions):
|
|
167
|
+
list(params?: RedirectRuleListParams | null | undefined, options?: RequestOptions): PagePromise<RedirectRulesCursorPage, RedirectRule>;
|
|
165
168
|
/**
|
|
166
169
|
* Deletes an existing redirect rule. The associated Redis cache entry is also
|
|
167
170
|
* invalidated.
|
|
@@ -231,6 +234,7 @@ export declare class RedirectRules extends APIResource {
|
|
|
231
234
|
*/
|
|
232
235
|
retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule>;
|
|
233
236
|
}
|
|
237
|
+
export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
|
|
234
238
|
export interface RedirectRule {
|
|
235
239
|
/**
|
|
236
240
|
* Redirect rule unique identifier
|
|
@@ -269,20 +273,6 @@ export interface RedirectRule {
|
|
|
269
273
|
*/
|
|
270
274
|
updatedAt: string;
|
|
271
275
|
}
|
|
272
|
-
export interface RedirectRuleListResponse {
|
|
273
|
-
/**
|
|
274
|
-
* Array of redirect rules
|
|
275
|
-
*/
|
|
276
|
-
data: Array<RedirectRule>;
|
|
277
|
-
/**
|
|
278
|
-
* Cursor for fetching the next page. Null if there are no more results.
|
|
279
|
-
*/
|
|
280
|
-
nextCursor: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Object type identifier
|
|
283
|
-
*/
|
|
284
|
-
object: 'list';
|
|
285
|
-
}
|
|
286
276
|
export interface RedirectRuleDeleteResponse {
|
|
287
277
|
/**
|
|
288
278
|
* Unique identifier of the deleted redirect rule
|
|
@@ -363,20 +353,11 @@ export interface RedirectRuleUpdateParams {
|
|
|
363
353
|
*/
|
|
364
354
|
'Featurebase-Version'?: string;
|
|
365
355
|
}
|
|
366
|
-
export interface RedirectRuleListParams {
|
|
367
|
-
/**
|
|
368
|
-
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
369
|
-
* previous response to fetch the next page.
|
|
370
|
-
*/
|
|
371
|
-
cursor?: string;
|
|
356
|
+
export interface RedirectRuleListParams extends CursorPageParams {
|
|
372
357
|
/**
|
|
373
358
|
* Query param: Filter redirect rules by help center ID
|
|
374
359
|
*/
|
|
375
360
|
helpCenterId?: string;
|
|
376
|
-
/**
|
|
377
|
-
* Query param: A limit on the number of objects to be returned, between 1 and 100.
|
|
378
|
-
*/
|
|
379
|
-
limit?: number;
|
|
380
361
|
/**
|
|
381
362
|
* Query param: Filter redirect rules by locale
|
|
382
363
|
*/
|
|
@@ -412,6 +393,6 @@ export interface RedirectRuleRetrieveByURLParams {
|
|
|
412
393
|
'Featurebase-Version'?: string;
|
|
413
394
|
}
|
|
414
395
|
export declare namespace RedirectRules {
|
|
415
|
-
export { type RedirectRule as RedirectRule, type
|
|
396
|
+
export { type RedirectRule as RedirectRule, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRulesCursorPage as RedirectRulesCursorPage, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
|
|
416
397
|
}
|
|
417
398
|
//# sourceMappingURL=redirect-rules.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirect-rules.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"redirect-rules.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAY5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAW3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAYxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAYrD;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAWzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAM,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAW3G;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,YAAY,CAAC;IAErC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;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,MAAM,CAAC;CAChC;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,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.RedirectRules = void 0;
|
|
5
5
|
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
6
7
|
const headers_1 = require("../../internal/headers.js");
|
|
7
8
|
const path_1 = require("../../internal/utils/path.js");
|
|
8
9
|
/**
|
|
@@ -190,13 +191,15 @@ class RedirectRules extends resource_1.APIResource {
|
|
|
190
191
|
*
|
|
191
192
|
* @example
|
|
192
193
|
* ```ts
|
|
193
|
-
*
|
|
194
|
-
*
|
|
194
|
+
* // Automatically fetches more pages as needed.
|
|
195
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
196
|
+
* // ...
|
|
197
|
+
* }
|
|
195
198
|
* ```
|
|
196
199
|
*/
|
|
197
200
|
list(params = {}, options) {
|
|
198
201
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
199
|
-
return this._client.
|
|
202
|
+
return this._client.getAPIList('/v2/help_center/redirect_rules', (pagination_1.CursorPage), {
|
|
200
203
|
query,
|
|
201
204
|
...options,
|
|
202
205
|
headers: (0, headers_1.buildHeaders)([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirect-rules.js","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"redirect-rules.js","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gCAAgC,EAAE,CAAA,uBAAwB,CAAA,EAAE;YACzF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAuC,EAAE,OAAwB;QAC7E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAC/D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA9SD,sCA8SC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../../core/pagination.mjs";
|
|
3
4
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
5
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
6
|
/**
|
|
@@ -187,13 +188,15 @@ export class RedirectRules extends APIResource {
|
|
|
187
188
|
*
|
|
188
189
|
* @example
|
|
189
190
|
* ```ts
|
|
190
|
-
*
|
|
191
|
-
*
|
|
191
|
+
* // Automatically fetches more pages as needed.
|
|
192
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
193
|
+
* // ...
|
|
194
|
+
* }
|
|
192
195
|
* ```
|
|
193
196
|
*/
|
|
194
197
|
list(params = {}, options) {
|
|
195
198
|
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
196
|
-
return this._client.
|
|
199
|
+
return this._client.getAPIList('/v2/help_center/redirect_rules', (CursorPage), {
|
|
197
200
|
query,
|
|
198
201
|
...options,
|
|
199
202
|
headers: buildHeaders([
|