featurebase-node 0.13.0 → 0.14.1
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 +23 -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 +21 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +21 -3
- package/client.d.ts.map +1 -1
- package/client.js +27 -1
- package/client.js.map +1 -1
- package/client.mjs +27 -1
- 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/audit-logs.d.mts +233 -0
- package/resources/audit-logs.d.mts.map +1 -0
- package/resources/audit-logs.d.ts +233 -0
- package/resources/audit-logs.d.ts.map +1 -0
- package/resources/audit-logs.js +122 -0
- package/resources/audit-logs.js.map +1 -0
- package/resources/audit-logs.mjs +118 -0
- package/resources/audit-logs.mjs.map +1 -0
- 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 +6 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -1
- package/resources/organization/admins.d.mts +33 -23
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +33 -23
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +27 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +27 -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/reports.d.mts +641 -0
- package/resources/reports.d.mts.map +1 -0
- package/resources/reports.d.ts +641 -0
- package/resources/reports.d.ts.map +1 -0
- package/resources/reports.js +238 -0
- package/resources/reports.js.map +1 -0
- package/resources/reports.mjs +234 -0
- package/resources/reports.mjs.map +1 -0
- 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 +80 -78
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +80 -78
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +79 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +79 -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 +98 -4
- package/src/resources/audit-logs.ts +607 -0
- 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 +37 -3
- package/src/resources/organization/admins.ts +45 -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/reports.ts +908 -0
- 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 +100 -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
|
@@ -21,19 +21,27 @@ class Contacts extends resource_1.APIResource {
|
|
|
21
21
|
this.emailPreferences = new EmailPreferencesAPI.EmailPreferences(this._client);
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* Returns both customers and leads.
|
|
24
|
+
* Returns a list of contacts (customers and leads) in your organization using
|
|
25
|
+
* cursor-based pagination.
|
|
27
26
|
*
|
|
28
|
-
* ###
|
|
27
|
+
* ### Query Parameters
|
|
29
28
|
*
|
|
30
|
-
* - `
|
|
29
|
+
* - `limit` - Number of contacts to return (1-100, default 10)
|
|
30
|
+
* - `cursor` - Cursor from previous response for pagination
|
|
31
|
+
* - `contactType` - Filter by contact type: "customer" (default), "lead", or "all"
|
|
31
32
|
*
|
|
32
33
|
* ### Response Format
|
|
33
34
|
*
|
|
34
|
-
* Returns a
|
|
35
|
+
* Returns a list object with:
|
|
36
|
+
*
|
|
37
|
+
* - `object` - Always "list"
|
|
38
|
+
* - `data` - Array of contact objects
|
|
39
|
+
* - `nextCursor` - Cursor for the next page, or null if no more results
|
|
40
|
+
*
|
|
41
|
+
* ### Contact Object
|
|
42
|
+
*
|
|
43
|
+
* Each contact includes:
|
|
35
44
|
*
|
|
36
|
-
* - `object` - Always "contact"
|
|
37
45
|
* - `id` - Unique contact identifier
|
|
38
46
|
* - `userId` - External user ID from SSO (if set)
|
|
39
47
|
* - `email` - Contact email address
|
|
@@ -50,11 +58,129 @@ class Contacts extends resource_1.APIResource {
|
|
|
50
58
|
*
|
|
51
59
|
* ```json
|
|
52
60
|
* {
|
|
61
|
+
* "object": "list",
|
|
62
|
+
* "data": [
|
|
63
|
+
* {
|
|
64
|
+
* "object": "contact",
|
|
65
|
+
* "id": "676f0f6765bdaa7d7d760f88",
|
|
66
|
+
* "email": "john@example.com",
|
|
67
|
+
* "name": "John Doe",
|
|
68
|
+
* "type": "customer",
|
|
69
|
+
* ...
|
|
70
|
+
* }
|
|
71
|
+
* ],
|
|
72
|
+
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
73
|
+
* }
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* ### Version Availability
|
|
77
|
+
*
|
|
78
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* // Automatically fetches more pages as needed.
|
|
83
|
+
* for await (const contact of client.users.contacts.list()) {
|
|
84
|
+
* // ...
|
|
85
|
+
* }
|
|
86
|
+
* ```
|
|
87
|
+
*/
|
|
88
|
+
list(params = {}, options) {
|
|
89
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
90
|
+
return this._client.getAPIList('/v2/contacts', (pagination_1.CursorPage), {
|
|
91
|
+
query,
|
|
92
|
+
...options,
|
|
93
|
+
headers: (0, headers_1.buildHeaders)([
|
|
94
|
+
{
|
|
95
|
+
...(featurebaseVersion?.toString() != null ?
|
|
96
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
97
|
+
: undefined),
|
|
98
|
+
},
|
|
99
|
+
options?.headers,
|
|
100
|
+
]),
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Creates a new contact or updates an existing one.
|
|
105
|
+
*
|
|
106
|
+
* If a contact with the given `email` or `userId` already exists, it will be
|
|
107
|
+
* updated. Otherwise, a new contact will be created.
|
|
108
|
+
*
|
|
109
|
+
* **At least one of `email` or `userId` must be provided for identification.**
|
|
110
|
+
*
|
|
111
|
+
* ### Request Body
|
|
112
|
+
*
|
|
113
|
+
* | Field | Type | Required | Description |
|
|
114
|
+
* | ----------------------- | ------- | ------------------- | --------------------------------------- |
|
|
115
|
+
* | `email` | string | One of email/userId | Contact email address |
|
|
116
|
+
* | `userId` | string | One of email/userId | External user ID from your system |
|
|
117
|
+
* | `name` | string | No | Contact display name |
|
|
118
|
+
* | `profilePicture` | string | No | Profile picture URL |
|
|
119
|
+
* | `companies` | array | No | Companies the contact belongs to |
|
|
120
|
+
* | `customFields` | object | No | Custom field values |
|
|
121
|
+
* | `subscribedToChangelog` | boolean | No | Whether subscribed to changelog |
|
|
122
|
+
* | `locale` | string | No | Contact locale/language |
|
|
123
|
+
* | `phone` | string | No | Contact phone number |
|
|
124
|
+
* | `roles` | array | No | Role IDs to assign |
|
|
125
|
+
* | `userHash` | string | No | HMAC hash for identity verification |
|
|
126
|
+
* | `createdAt` | string | No | When the contact was created (ISO 8601) |
|
|
127
|
+
*
|
|
128
|
+
* ### Company Object
|
|
129
|
+
*
|
|
130
|
+
* Each company in the `companies` array can have:
|
|
131
|
+
*
|
|
132
|
+
* - `id` (required) - External company ID from your system
|
|
133
|
+
* - `name` (required) - Company name
|
|
134
|
+
* - `monthlySpend` - Monthly spend/revenue
|
|
135
|
+
* - `customFields` - Custom field values
|
|
136
|
+
* - `industry` - Industry
|
|
137
|
+
* - `website` - Company website URL
|
|
138
|
+
* - `plan` - Current plan/subscription
|
|
139
|
+
* - `companySize` - Number of employees
|
|
140
|
+
* - `createdAt` - When the company was created
|
|
141
|
+
*
|
|
142
|
+
* ### Response
|
|
143
|
+
*
|
|
144
|
+
* Returns the created or updated contact object.
|
|
145
|
+
*
|
|
146
|
+
* - **201 Created** - A new contact was created
|
|
147
|
+
* - **200 OK** - An existing contact was updated
|
|
148
|
+
*
|
|
149
|
+
* ### Example Request
|
|
150
|
+
*
|
|
151
|
+
* ```json
|
|
152
|
+
* {
|
|
153
|
+
* "email": "john@example.com",
|
|
154
|
+
* "name": "John Doe",
|
|
155
|
+
* "userId": "usr_12345",
|
|
156
|
+
* "companies": [
|
|
157
|
+
* {
|
|
158
|
+
* "id": "company_123",
|
|
159
|
+
* "name": "Acme Inc",
|
|
160
|
+
* "monthlySpend": 500,
|
|
161
|
+
* "plan": "enterprise"
|
|
162
|
+
* }
|
|
163
|
+
* ],
|
|
164
|
+
* "customFields": {
|
|
165
|
+
* "plan": "pro",
|
|
166
|
+
* "signupSource": "website"
|
|
167
|
+
* },
|
|
168
|
+
* "subscribedToChangelog": true
|
|
169
|
+
* }
|
|
170
|
+
* ```
|
|
171
|
+
*
|
|
172
|
+
* ### Example Response
|
|
173
|
+
*
|
|
174
|
+
* ```json
|
|
175
|
+
* {
|
|
53
176
|
* "object": "contact",
|
|
54
177
|
* "id": "676f0f6765bdaa7d7d760f88",
|
|
55
178
|
* "email": "john@example.com",
|
|
56
179
|
* "name": "John Doe",
|
|
180
|
+
* "userId": "usr_12345",
|
|
57
181
|
* "type": "customer",
|
|
182
|
+
* "companies": [...],
|
|
183
|
+
* "customFields": {...},
|
|
58
184
|
* ...
|
|
59
185
|
* }
|
|
60
186
|
* ```
|
|
@@ -65,14 +191,14 @@ class Contacts extends resource_1.APIResource {
|
|
|
65
191
|
*
|
|
66
192
|
* @example
|
|
67
193
|
* ```ts
|
|
68
|
-
* const
|
|
69
|
-
*
|
|
70
|
-
* );
|
|
194
|
+
* const response =
|
|
195
|
+
* await client.users.contacts.createOrUpdate();
|
|
71
196
|
* ```
|
|
72
197
|
*/
|
|
73
|
-
|
|
74
|
-
const { 'Featurebase-Version': featurebaseVersion } = params
|
|
75
|
-
return this._client.
|
|
198
|
+
createOrUpdate(params, options) {
|
|
199
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
200
|
+
return this._client.post('/v2/contacts', {
|
|
201
|
+
body,
|
|
76
202
|
...options,
|
|
77
203
|
headers: (0, headers_1.buildHeaders)([
|
|
78
204
|
{
|
|
@@ -85,27 +211,19 @@ class Contacts extends resource_1.APIResource {
|
|
|
85
211
|
});
|
|
86
212
|
}
|
|
87
213
|
/**
|
|
88
|
-
*
|
|
89
|
-
* cursor-based pagination.
|
|
90
|
-
*
|
|
91
|
-
* ### Query Parameters
|
|
92
|
-
*
|
|
93
|
-
* - `limit` - Number of contacts to return (1-100, default 10)
|
|
94
|
-
* - `cursor` - Cursor from previous response for pagination
|
|
95
|
-
* - `contactType` - Filter by contact type: "customer" (default), "lead", or "all"
|
|
214
|
+
* Retrieves a single contact by their Featurebase ID.
|
|
96
215
|
*
|
|
97
|
-
*
|
|
216
|
+
* Returns both customers and leads.
|
|
98
217
|
*
|
|
99
|
-
*
|
|
218
|
+
* ### Path Parameters
|
|
100
219
|
*
|
|
101
|
-
* - `
|
|
102
|
-
* - `data` - Array of contact objects
|
|
103
|
-
* - `nextCursor` - Cursor for the next page, or null if no more results
|
|
220
|
+
* - `id` - The Featurebase contact ID (24-character ObjectId)
|
|
104
221
|
*
|
|
105
|
-
* ###
|
|
222
|
+
* ### Response Format
|
|
106
223
|
*
|
|
107
|
-
*
|
|
224
|
+
* Returns a single contact object with:
|
|
108
225
|
*
|
|
226
|
+
* - `object` - Always "contact"
|
|
109
227
|
* - `id` - Unique contact identifier
|
|
110
228
|
* - `userId` - External user ID from SSO (if set)
|
|
111
229
|
* - `email` - Contact email address
|
|
@@ -122,18 +240,12 @@ class Contacts extends resource_1.APIResource {
|
|
|
122
240
|
*
|
|
123
241
|
* ```json
|
|
124
242
|
* {
|
|
125
|
-
* "object": "
|
|
126
|
-
* "
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
* "name": "John Doe",
|
|
132
|
-
* "type": "customer",
|
|
133
|
-
* ...
|
|
134
|
-
* }
|
|
135
|
-
* ],
|
|
136
|
-
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
243
|
+
* "object": "contact",
|
|
244
|
+
* "id": "676f0f6765bdaa7d7d760f88",
|
|
245
|
+
* "email": "john@example.com",
|
|
246
|
+
* "name": "John Doe",
|
|
247
|
+
* "type": "customer",
|
|
248
|
+
* ...
|
|
137
249
|
* }
|
|
138
250
|
* ```
|
|
139
251
|
*
|
|
@@ -143,16 +255,14 @@ class Contacts extends resource_1.APIResource {
|
|
|
143
255
|
*
|
|
144
256
|
* @example
|
|
145
257
|
* ```ts
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
* }
|
|
258
|
+
* const contact = await client.users.contacts.retrieve(
|
|
259
|
+
* '507f1f77bcf86cd799439011',
|
|
260
|
+
* );
|
|
150
261
|
* ```
|
|
151
262
|
*/
|
|
152
|
-
|
|
153
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
154
|
-
return this._client.
|
|
155
|
-
query,
|
|
263
|
+
retrieve(id, params = {}, options) {
|
|
264
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
265
|
+
return this._client.get((0, path_1.path) `/v2/contacts/${id}`, {
|
|
156
266
|
...options,
|
|
157
267
|
headers: (0, headers_1.buildHeaders)([
|
|
158
268
|
{
|
|
@@ -226,7 +336,7 @@ class Contacts extends resource_1.APIResource {
|
|
|
226
336
|
});
|
|
227
337
|
}
|
|
228
338
|
/**
|
|
229
|
-
* Blocks a contact by their Featurebase ID
|
|
339
|
+
* Blocks a contact by their Featurebase ID using the global moderation system.
|
|
230
340
|
*
|
|
231
341
|
* ### Path Parameters
|
|
232
342
|
*
|
|
@@ -244,6 +354,8 @@ class Contacts extends resource_1.APIResource {
|
|
|
244
354
|
* When a contact is blocked:
|
|
245
355
|
*
|
|
246
356
|
* - The contact cannot send new messages via messenger
|
|
357
|
+
* - The contact cannot interact with feedback/changelog surfaces for this
|
|
358
|
+
* organization
|
|
247
359
|
* - Existing conversations are not deleted but no new messages can be added by the
|
|
248
360
|
* blocked user
|
|
249
361
|
* - The block can be removed by unblocking the contact
|
|
@@ -292,87 +404,42 @@ class Contacts extends resource_1.APIResource {
|
|
|
292
404
|
});
|
|
293
405
|
}
|
|
294
406
|
/**
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
* If a contact with the given `email` or `userId` already exists, it will be
|
|
298
|
-
* updated. Otherwise, a new contact will be created.
|
|
407
|
+
* Unblocks a contact by their Featurebase ID from the global moderation system.
|
|
299
408
|
*
|
|
300
|
-
*
|
|
409
|
+
* ### Path Parameters
|
|
301
410
|
*
|
|
302
|
-
*
|
|
411
|
+
* - `id` - The Featurebase internal ID of the contact (MongoDB ObjectId)
|
|
303
412
|
*
|
|
304
|
-
*
|
|
305
|
-
* | ----------------------- | ------- | ------------------- | --------------------------------------- |
|
|
306
|
-
* | `email` | string | One of email/userId | Contact email address |
|
|
307
|
-
* | `userId` | string | One of email/userId | External user ID from your system |
|
|
308
|
-
* | `name` | string | No | Contact display name |
|
|
309
|
-
* | `profilePicture` | string | No | Profile picture URL |
|
|
310
|
-
* | `companies` | array | No | Companies the contact belongs to |
|
|
311
|
-
* | `customFields` | object | No | Custom field values |
|
|
312
|
-
* | `subscribedToChangelog` | boolean | No | Whether subscribed to changelog |
|
|
313
|
-
* | `locale` | string | No | Contact locale/language |
|
|
314
|
-
* | `phone` | string | No | Contact phone number |
|
|
315
|
-
* | `roles` | array | No | Role IDs to assign |
|
|
316
|
-
* | `userHash` | string | No | HMAC hash for identity verification |
|
|
317
|
-
* | `createdAt` | string | No | When the contact was created (ISO 8601) |
|
|
413
|
+
* ### Supported Contact Types
|
|
318
414
|
*
|
|
319
|
-
*
|
|
415
|
+
* This endpoint unblocks both:
|
|
320
416
|
*
|
|
321
|
-
*
|
|
417
|
+
* - **Customers** - Users with registered accounts
|
|
418
|
+
* - **Leads** - Anonymous or unregistered visitors
|
|
322
419
|
*
|
|
323
|
-
*
|
|
324
|
-
* - `name` (required) - Company name
|
|
325
|
-
* - `monthlySpend` - Monthly spend/revenue
|
|
326
|
-
* - `customFields` - Custom field values
|
|
327
|
-
* - `industry` - Industry
|
|
328
|
-
* - `website` - Company website URL
|
|
329
|
-
* - `plan` - Current plan/subscription
|
|
330
|
-
* - `companySize` - Number of employees
|
|
331
|
-
* - `createdAt` - When the company was created
|
|
420
|
+
* ### Unblocking Behavior
|
|
332
421
|
*
|
|
333
|
-
*
|
|
422
|
+
* When a contact is unblocked:
|
|
334
423
|
*
|
|
335
|
-
*
|
|
424
|
+
* - The contact can resume sending messages via messenger
|
|
425
|
+
* - Previously blocked conversations remain intact
|
|
426
|
+
* - The contact regains full messenger functionality
|
|
336
427
|
*
|
|
337
|
-
*
|
|
338
|
-
* - **200 OK** - An existing contact was updated
|
|
428
|
+
* ### Response
|
|
339
429
|
*
|
|
340
|
-
*
|
|
430
|
+
* Returns an unblock confirmation object:
|
|
341
431
|
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
* "name": "John Doe",
|
|
346
|
-
* "userId": "usr_12345",
|
|
347
|
-
* "companies": [
|
|
348
|
-
* {
|
|
349
|
-
* "id": "company_123",
|
|
350
|
-
* "name": "Acme Inc",
|
|
351
|
-
* "monthlySpend": 500,
|
|
352
|
-
* "plan": "enterprise"
|
|
353
|
-
* }
|
|
354
|
-
* ],
|
|
355
|
-
* "customFields": {
|
|
356
|
-
* "plan": "pro",
|
|
357
|
-
* "signupSource": "website"
|
|
358
|
-
* },
|
|
359
|
-
* "subscribedToChangelog": true
|
|
360
|
-
* }
|
|
361
|
-
* ```
|
|
432
|
+
* - `id` - The ID of the unblocked contact
|
|
433
|
+
* - `object` - Always "contact"
|
|
434
|
+
* - `unblocked` - Always `true`
|
|
362
435
|
*
|
|
363
436
|
* ### Example Response
|
|
364
437
|
*
|
|
365
438
|
* ```json
|
|
366
439
|
* {
|
|
440
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
367
441
|
* "object": "contact",
|
|
368
|
-
* "
|
|
369
|
-
* "email": "john@example.com",
|
|
370
|
-
* "name": "John Doe",
|
|
371
|
-
* "userId": "usr_12345",
|
|
372
|
-
* "type": "customer",
|
|
373
|
-
* "companies": [...],
|
|
374
|
-
* "customFields": {...},
|
|
375
|
-
* ...
|
|
442
|
+
* "unblocked": true
|
|
376
443
|
* }
|
|
377
444
|
* ```
|
|
378
445
|
*
|
|
@@ -382,14 +449,14 @@ class Contacts extends resource_1.APIResource {
|
|
|
382
449
|
*
|
|
383
450
|
* @example
|
|
384
451
|
* ```ts
|
|
385
|
-
* const response =
|
|
386
|
-
*
|
|
452
|
+
* const response = await client.users.contacts.unblock(
|
|
453
|
+
* '507f1f77bcf86cd799439011',
|
|
454
|
+
* );
|
|
387
455
|
* ```
|
|
388
456
|
*/
|
|
389
|
-
|
|
390
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
391
|
-
return this._client.post(
|
|
392
|
-
body,
|
|
457
|
+
unblock(id, params = {}, options) {
|
|
458
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
459
|
+
return this._client.post((0, path_1.path) `/v2/contacts/${id}/unblock`, {
|
|
393
460
|
...options,
|
|
394
461
|
headers: (0, headers_1.buildHeaders)([
|
|
395
462
|
{
|
|
@@ -510,71 +577,6 @@ class Contacts extends resource_1.APIResource {
|
|
|
510
577
|
]),
|
|
511
578
|
});
|
|
512
579
|
}
|
|
513
|
-
/**
|
|
514
|
-
* Unblocks a contact by their Featurebase ID from the messenger/inbox.
|
|
515
|
-
*
|
|
516
|
-
* ### Path Parameters
|
|
517
|
-
*
|
|
518
|
-
* - `id` - The Featurebase internal ID of the contact (MongoDB ObjectId)
|
|
519
|
-
*
|
|
520
|
-
* ### Supported Contact Types
|
|
521
|
-
*
|
|
522
|
-
* This endpoint unblocks both:
|
|
523
|
-
*
|
|
524
|
-
* - **Customers** - Users with registered accounts
|
|
525
|
-
* - **Leads** - Anonymous or unregistered visitors
|
|
526
|
-
*
|
|
527
|
-
* ### Unblocking Behavior
|
|
528
|
-
*
|
|
529
|
-
* When a contact is unblocked:
|
|
530
|
-
*
|
|
531
|
-
* - The contact can resume sending messages via messenger
|
|
532
|
-
* - Previously blocked conversations remain intact
|
|
533
|
-
* - The contact regains full messenger functionality
|
|
534
|
-
*
|
|
535
|
-
* ### Response
|
|
536
|
-
*
|
|
537
|
-
* Returns an unblock confirmation object:
|
|
538
|
-
*
|
|
539
|
-
* - `id` - The ID of the unblocked contact
|
|
540
|
-
* - `object` - Always "contact"
|
|
541
|
-
* - `unblocked` - Always `true`
|
|
542
|
-
*
|
|
543
|
-
* ### Example Response
|
|
544
|
-
*
|
|
545
|
-
* ```json
|
|
546
|
-
* {
|
|
547
|
-
* "id": "507f1f77bcf86cd799439011",
|
|
548
|
-
* "object": "contact",
|
|
549
|
-
* "unblocked": true
|
|
550
|
-
* }
|
|
551
|
-
* ```
|
|
552
|
-
*
|
|
553
|
-
* ### Version Availability
|
|
554
|
-
*
|
|
555
|
-
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
556
|
-
*
|
|
557
|
-
* @example
|
|
558
|
-
* ```ts
|
|
559
|
-
* const response = await client.users.contacts.unblock(
|
|
560
|
-
* '507f1f77bcf86cd799439011',
|
|
561
|
-
* );
|
|
562
|
-
* ```
|
|
563
|
-
*/
|
|
564
|
-
unblock(id, params = {}, options) {
|
|
565
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
566
|
-
return this._client.post((0, path_1.path) `/v2/contacts/${id}/unblock`, {
|
|
567
|
-
...options,
|
|
568
|
-
headers: (0, headers_1.buildHeaders)([
|
|
569
|
-
{
|
|
570
|
-
...(featurebaseVersion?.toString() != null ?
|
|
571
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
572
|
-
: undefined),
|
|
573
|
-
},
|
|
574
|
-
options?.headers,
|
|
575
|
-
]),
|
|
576
|
-
});
|
|
577
|
-
}
|
|
578
580
|
}
|
|
579
581
|
exports.Contacts = Contacts;
|
|
580
582
|
Contacts.ByUserID = by_user_id_1.ByUserID;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../../src/resources/users/contacts/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;
|
|
1
|
+
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../../src/resources/users/contacts/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAIrD,oFAA2D;AAC3D,8DAO6B;AAC7B,gFAAuD;AACvD,2DAKiC;AAEjC,4DAA0F;AAC1F,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IA2kBJ,CAAC;IAzkBC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAA4B,CAAA,EAAE;YAC3E,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8FG;IACH,cAAc,CACZ,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,KAAK,CACH,EAAU,EACV,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,QAAQ,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,OAAO,CACL,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,UAAU,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6FG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAC9C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA/kBD,4BA+kBC;AAojBD,QAAQ,CAAC,QAAQ,GAAG,qBAAQ,CAAC;AAC7B,QAAQ,CAAC,gBAAgB,GAAG,oCAAgB,CAAC"}
|