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
|
@@ -17,6 +17,80 @@ class Changelogs extends resource_1.APIResource {
|
|
|
17
17
|
super(...arguments);
|
|
18
18
|
this.subscribers = new SubscribersAPI.Subscribers(this._client);
|
|
19
19
|
}
|
|
20
|
+
/**
|
|
21
|
+
* Returns all changelogs for the authenticated organization.
|
|
22
|
+
*
|
|
23
|
+
* Changelogs are release notes and updates that keep users informed about new
|
|
24
|
+
* features, improvements, and bug fixes. Each changelog can have:
|
|
25
|
+
*
|
|
26
|
+
* - Multiple translations (locales)
|
|
27
|
+
* - Categories for organization
|
|
28
|
+
* - Featured images
|
|
29
|
+
* - Scheduled publishing
|
|
30
|
+
*
|
|
31
|
+
* ### Pagination
|
|
32
|
+
*
|
|
33
|
+
* This endpoint uses **cursor-based pagination**:
|
|
34
|
+
*
|
|
35
|
+
* - `limit` - Number of changelogs to return (1-100, default 10)
|
|
36
|
+
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
37
|
+
*
|
|
38
|
+
* **Example:** To paginate through results:
|
|
39
|
+
*
|
|
40
|
+
* 1. First request: `GET /v2/changelogs?limit=10`
|
|
41
|
+
* 2. If `nextCursor` is not null, use it for the next page
|
|
42
|
+
* 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
|
|
43
|
+
*
|
|
44
|
+
* ### Response Format
|
|
45
|
+
*
|
|
46
|
+
* Returns a list object with:
|
|
47
|
+
*
|
|
48
|
+
* - `object` - Always "list"
|
|
49
|
+
* - `data` - Array of changelog objects
|
|
50
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
51
|
+
*
|
|
52
|
+
* ### Filtering
|
|
53
|
+
*
|
|
54
|
+
* Filter changelogs using query parameters:
|
|
55
|
+
*
|
|
56
|
+
* - `id` - Find a specific changelog by ID or slug
|
|
57
|
+
* - `q` - Search query for title/content
|
|
58
|
+
* - `categories` - Filter by category names
|
|
59
|
+
* - `locale` - Get changelogs in a specific locale (defaults to org default)
|
|
60
|
+
* - `state` - Filter by state: `live`, `draft`, or `all`
|
|
61
|
+
* - `startDate` - Include changelogs dated on or after this date
|
|
62
|
+
* - `endDate` - Include changelogs dated on or before this date
|
|
63
|
+
*
|
|
64
|
+
* ### Sorting
|
|
65
|
+
*
|
|
66
|
+
* Results are sorted by date (descending by default):
|
|
67
|
+
*
|
|
68
|
+
* - `sortBy` - Field to sort by (currently only `date`)
|
|
69
|
+
* - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* // Automatically fetches more pages as needed.
|
|
74
|
+
* for await (const changelog of client.changelogs.list()) {
|
|
75
|
+
* // ...
|
|
76
|
+
* }
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
list(params = {}, options) {
|
|
80
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
81
|
+
return this._client.getAPIList('/v2/changelogs', (pagination_1.CursorPage), {
|
|
82
|
+
query,
|
|
83
|
+
...options,
|
|
84
|
+
headers: (0, headers_1.buildHeaders)([
|
|
85
|
+
{
|
|
86
|
+
...(featurebaseVersion?.toString() != null ?
|
|
87
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
88
|
+
: undefined),
|
|
89
|
+
},
|
|
90
|
+
options?.headers,
|
|
91
|
+
]),
|
|
92
|
+
});
|
|
93
|
+
}
|
|
20
94
|
/**
|
|
21
95
|
* Creates a new changelog for the authenticated organization.
|
|
22
96
|
*
|
|
@@ -180,80 +254,6 @@ class Changelogs extends resource_1.APIResource {
|
|
|
180
254
|
]),
|
|
181
255
|
});
|
|
182
256
|
}
|
|
183
|
-
/**
|
|
184
|
-
* Returns all changelogs for the authenticated organization.
|
|
185
|
-
*
|
|
186
|
-
* Changelogs are release notes and updates that keep users informed about new
|
|
187
|
-
* features, improvements, and bug fixes. Each changelog can have:
|
|
188
|
-
*
|
|
189
|
-
* - Multiple translations (locales)
|
|
190
|
-
* - Categories for organization
|
|
191
|
-
* - Featured images
|
|
192
|
-
* - Scheduled publishing
|
|
193
|
-
*
|
|
194
|
-
* ### Pagination
|
|
195
|
-
*
|
|
196
|
-
* This endpoint uses **cursor-based pagination**:
|
|
197
|
-
*
|
|
198
|
-
* - `limit` - Number of changelogs to return (1-100, default 10)
|
|
199
|
-
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
200
|
-
*
|
|
201
|
-
* **Example:** To paginate through results:
|
|
202
|
-
*
|
|
203
|
-
* 1. First request: `GET /v2/changelogs?limit=10`
|
|
204
|
-
* 2. If `nextCursor` is not null, use it for the next page
|
|
205
|
-
* 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
|
|
206
|
-
*
|
|
207
|
-
* ### Response Format
|
|
208
|
-
*
|
|
209
|
-
* Returns a list object with:
|
|
210
|
-
*
|
|
211
|
-
* - `object` - Always "list"
|
|
212
|
-
* - `data` - Array of changelog objects
|
|
213
|
-
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
214
|
-
*
|
|
215
|
-
* ### Filtering
|
|
216
|
-
*
|
|
217
|
-
* Filter changelogs using query parameters:
|
|
218
|
-
*
|
|
219
|
-
* - `id` - Find a specific changelog by ID or slug
|
|
220
|
-
* - `q` - Search query for title/content
|
|
221
|
-
* - `categories` - Filter by category names
|
|
222
|
-
* - `locale` - Get changelogs in a specific locale (defaults to org default)
|
|
223
|
-
* - `state` - Filter by state: `live`, `draft`, or `all`
|
|
224
|
-
* - `startDate` - Include changelogs dated on or after this date
|
|
225
|
-
* - `endDate` - Include changelogs dated on or before this date
|
|
226
|
-
*
|
|
227
|
-
* ### Sorting
|
|
228
|
-
*
|
|
229
|
-
* Results are sorted by date (descending by default):
|
|
230
|
-
*
|
|
231
|
-
* - `sortBy` - Field to sort by (currently only `date`)
|
|
232
|
-
* - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
|
|
233
|
-
*
|
|
234
|
-
* @example
|
|
235
|
-
* ```ts
|
|
236
|
-
* // Automatically fetches more pages as needed.
|
|
237
|
-
* for await (const changelog of client.changelogs.list()) {
|
|
238
|
-
* // ...
|
|
239
|
-
* }
|
|
240
|
-
* ```
|
|
241
|
-
*/
|
|
242
|
-
list(params = {}, options) {
|
|
243
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
244
|
-
return this._client.getAPIList('/v2/changelogs', (pagination_1.CursorPage), {
|
|
245
|
-
query,
|
|
246
|
-
...options,
|
|
247
|
-
headers: (0, headers_1.buildHeaders)([
|
|
248
|
-
{
|
|
249
|
-
...(featurebaseVersion?.toString() != null ?
|
|
250
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
251
|
-
: undefined),
|
|
252
|
-
},
|
|
253
|
-
options?.headers,
|
|
254
|
-
]),
|
|
255
|
-
});
|
|
256
|
-
}
|
|
257
257
|
/**
|
|
258
258
|
* Deletes a changelog by its unique identifier.
|
|
259
259
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"changelogs.js","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,yEAAgD;AAChD,kDAMuB;AAEvB,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0bzF,CAAC;IAxbC
|
|
1
|
+
{"version":3,"file":"changelogs.js","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,yEAAgD;AAChD,kDAMuB;AAEvB,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0bzF,CAAC;IAxbC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,uBAAqB,CAAA,EAAE;YACtE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,MAAM,CAAC,MAA6B,EAAE,OAAwB;QAC5D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,EAAE,EAAE;YAClD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA6B,EAAE,OAAwB;QACxE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,EAAE,EAAE;YACpD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,EAAE,EAAE;YACrD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,OAAO,CACL,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,UAAU,EAAE;YAC3D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,SAAS,CACP,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,YAAY,EAAE;YAC7D,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;AA3bD,gCA2bC;AAwnBD,UAAU,CAAC,WAAW,GAAG,yBAAW,CAAC"}
|
|
@@ -13,6 +13,80 @@ export class Changelogs extends APIResource {
|
|
|
13
13
|
super(...arguments);
|
|
14
14
|
this.subscribers = new SubscribersAPI.Subscribers(this._client);
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* Returns all changelogs for the authenticated organization.
|
|
18
|
+
*
|
|
19
|
+
* Changelogs are release notes and updates that keep users informed about new
|
|
20
|
+
* features, improvements, and bug fixes. Each changelog can have:
|
|
21
|
+
*
|
|
22
|
+
* - Multiple translations (locales)
|
|
23
|
+
* - Categories for organization
|
|
24
|
+
* - Featured images
|
|
25
|
+
* - Scheduled publishing
|
|
26
|
+
*
|
|
27
|
+
* ### Pagination
|
|
28
|
+
*
|
|
29
|
+
* This endpoint uses **cursor-based pagination**:
|
|
30
|
+
*
|
|
31
|
+
* - `limit` - Number of changelogs to return (1-100, default 10)
|
|
32
|
+
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
33
|
+
*
|
|
34
|
+
* **Example:** To paginate through results:
|
|
35
|
+
*
|
|
36
|
+
* 1. First request: `GET /v2/changelogs?limit=10`
|
|
37
|
+
* 2. If `nextCursor` is not null, use it for the next page
|
|
38
|
+
* 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
|
|
39
|
+
*
|
|
40
|
+
* ### Response Format
|
|
41
|
+
*
|
|
42
|
+
* Returns a list object with:
|
|
43
|
+
*
|
|
44
|
+
* - `object` - Always "list"
|
|
45
|
+
* - `data` - Array of changelog objects
|
|
46
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
47
|
+
*
|
|
48
|
+
* ### Filtering
|
|
49
|
+
*
|
|
50
|
+
* Filter changelogs using query parameters:
|
|
51
|
+
*
|
|
52
|
+
* - `id` - Find a specific changelog by ID or slug
|
|
53
|
+
* - `q` - Search query for title/content
|
|
54
|
+
* - `categories` - Filter by category names
|
|
55
|
+
* - `locale` - Get changelogs in a specific locale (defaults to org default)
|
|
56
|
+
* - `state` - Filter by state: `live`, `draft`, or `all`
|
|
57
|
+
* - `startDate` - Include changelogs dated on or after this date
|
|
58
|
+
* - `endDate` - Include changelogs dated on or before this date
|
|
59
|
+
*
|
|
60
|
+
* ### Sorting
|
|
61
|
+
*
|
|
62
|
+
* Results are sorted by date (descending by default):
|
|
63
|
+
*
|
|
64
|
+
* - `sortBy` - Field to sort by (currently only `date`)
|
|
65
|
+
* - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* // Automatically fetches more pages as needed.
|
|
70
|
+
* for await (const changelog of client.changelogs.list()) {
|
|
71
|
+
* // ...
|
|
72
|
+
* }
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
list(params = {}, options) {
|
|
76
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
77
|
+
return this._client.getAPIList('/v2/changelogs', (CursorPage), {
|
|
78
|
+
query,
|
|
79
|
+
...options,
|
|
80
|
+
headers: buildHeaders([
|
|
81
|
+
{
|
|
82
|
+
...(featurebaseVersion?.toString() != null ?
|
|
83
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
84
|
+
: undefined),
|
|
85
|
+
},
|
|
86
|
+
options?.headers,
|
|
87
|
+
]),
|
|
88
|
+
});
|
|
89
|
+
}
|
|
16
90
|
/**
|
|
17
91
|
* Creates a new changelog for the authenticated organization.
|
|
18
92
|
*
|
|
@@ -176,80 +250,6 @@ export class Changelogs extends APIResource {
|
|
|
176
250
|
]),
|
|
177
251
|
});
|
|
178
252
|
}
|
|
179
|
-
/**
|
|
180
|
-
* Returns all changelogs for the authenticated organization.
|
|
181
|
-
*
|
|
182
|
-
* Changelogs are release notes and updates that keep users informed about new
|
|
183
|
-
* features, improvements, and bug fixes. Each changelog can have:
|
|
184
|
-
*
|
|
185
|
-
* - Multiple translations (locales)
|
|
186
|
-
* - Categories for organization
|
|
187
|
-
* - Featured images
|
|
188
|
-
* - Scheduled publishing
|
|
189
|
-
*
|
|
190
|
-
* ### Pagination
|
|
191
|
-
*
|
|
192
|
-
* This endpoint uses **cursor-based pagination**:
|
|
193
|
-
*
|
|
194
|
-
* - `limit` - Number of changelogs to return (1-100, default 10)
|
|
195
|
-
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
196
|
-
*
|
|
197
|
-
* **Example:** To paginate through results:
|
|
198
|
-
*
|
|
199
|
-
* 1. First request: `GET /v2/changelogs?limit=10`
|
|
200
|
-
* 2. If `nextCursor` is not null, use it for the next page
|
|
201
|
-
* 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
|
|
202
|
-
*
|
|
203
|
-
* ### Response Format
|
|
204
|
-
*
|
|
205
|
-
* Returns a list object with:
|
|
206
|
-
*
|
|
207
|
-
* - `object` - Always "list"
|
|
208
|
-
* - `data` - Array of changelog objects
|
|
209
|
-
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
210
|
-
*
|
|
211
|
-
* ### Filtering
|
|
212
|
-
*
|
|
213
|
-
* Filter changelogs using query parameters:
|
|
214
|
-
*
|
|
215
|
-
* - `id` - Find a specific changelog by ID or slug
|
|
216
|
-
* - `q` - Search query for title/content
|
|
217
|
-
* - `categories` - Filter by category names
|
|
218
|
-
* - `locale` - Get changelogs in a specific locale (defaults to org default)
|
|
219
|
-
* - `state` - Filter by state: `live`, `draft`, or `all`
|
|
220
|
-
* - `startDate` - Include changelogs dated on or after this date
|
|
221
|
-
* - `endDate` - Include changelogs dated on or before this date
|
|
222
|
-
*
|
|
223
|
-
* ### Sorting
|
|
224
|
-
*
|
|
225
|
-
* Results are sorted by date (descending by default):
|
|
226
|
-
*
|
|
227
|
-
* - `sortBy` - Field to sort by (currently only `date`)
|
|
228
|
-
* - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
|
|
229
|
-
*
|
|
230
|
-
* @example
|
|
231
|
-
* ```ts
|
|
232
|
-
* // Automatically fetches more pages as needed.
|
|
233
|
-
* for await (const changelog of client.changelogs.list()) {
|
|
234
|
-
* // ...
|
|
235
|
-
* }
|
|
236
|
-
* ```
|
|
237
|
-
*/
|
|
238
|
-
list(params = {}, options) {
|
|
239
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
240
|
-
return this._client.getAPIList('/v2/changelogs', (CursorPage), {
|
|
241
|
-
query,
|
|
242
|
-
...options,
|
|
243
|
-
headers: buildHeaders([
|
|
244
|
-
{
|
|
245
|
-
...(featurebaseVersion?.toString() != null ?
|
|
246
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
247
|
-
: undefined),
|
|
248
|
-
},
|
|
249
|
-
options?.headers,
|
|
250
|
-
]),
|
|
251
|
-
});
|
|
252
|
-
}
|
|
253
253
|
/**
|
|
254
254
|
* Deletes a changelog by its unique identifier.
|
|
255
255
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF;
|
|
1
|
+
{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAKL,WAAW,GACZ,0BAAsB;AAEvB,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0bzF,CAAC;IAxbC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,UAAqB,CAAA,EAAE;YACtE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,MAAM,CAAC,MAA6B,EAAE,OAAwB;QAC5D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA6B,EAAE,OAAwB;QACxE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,OAAO,CACL,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,UAAU,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,SAAS,CACP,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,YAAY,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAwnBD,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type
|
|
1
|
+
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type ChangelogListParams, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, type ChangelogsCursorPage, } from "./changelogs.mjs";
|
|
2
2
|
export { Subscribers, type SubscriberAddResponse, type SubscriberRemoveResponse, type SubscriberAddParams, type SubscriberRemoveParams, } from "./subscribers.mjs";
|
|
3
3
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B,yBAAqB;AACtB,OAAO,EACL,WAAW,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,0BAAsB"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type
|
|
1
|
+
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type ChangelogListParams, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, type ChangelogsCursorPage, } from "./changelogs.js";
|
|
2
2
|
export { Subscribers, type SubscriberAddResponse, type SubscriberRemoveResponse, type SubscriberAddParams, type SubscriberRemoveParams, } from "./subscribers.js";
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B,wBAAqB;AACtB,OAAO,EACL,WAAW,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,yBAAsB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,UAAU,GAYX,yBAAqB;AACtB,OAAO,EACL,WAAW,GAKZ,0BAAsB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribers.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"subscribers.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAgB7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAevG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;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;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAgB7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAevG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;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;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribers.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAAA,sFAAsF;
|
|
1
|
+
{"version":3,"file":"subscribers.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAA2B,EAAE,OAAwB;QACvD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;YACvD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"changelogs.d.mts","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"changelogs.d.mts","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":"AAEA,uCAAmC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"changelogs.d.ts","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"changelogs.d.ts","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":"AAEA,sCAAmC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
|
1
|
+
{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,uCAAmC"}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Conversation custom attribute definitions configured in your Featurebase organization. Use these definitions to map ID-keyed conversation custom attributes to human-readable names and value types.
|
|
6
|
+
*/
|
|
7
|
+
export declare class ConversationAttributes extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns conversation custom attribute definitions configured in your
|
|
10
|
+
* organization.
|
|
11
|
+
*
|
|
12
|
+
* Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
|
|
13
|
+
* Use this endpoint to map those IDs to display names, identifiers, data types,
|
|
14
|
+
* field subtypes, and select options.
|
|
15
|
+
*
|
|
16
|
+
* By default, archived definitions are excluded. Set `includeArchived=true` to
|
|
17
|
+
* include archived definitions.
|
|
18
|
+
*/
|
|
19
|
+
list(params?: ConversationAttributeListParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttributeListResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
22
|
+
*
|
|
23
|
+
* Use this when a conversation response contains a `customAttributes` key and you
|
|
24
|
+
* need the corresponding display name, identifier, data type, field subtype, or
|
|
25
|
+
* options.
|
|
26
|
+
*/
|
|
27
|
+
retrieve(id: string, params?: ConversationAttributeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttribute>;
|
|
28
|
+
}
|
|
29
|
+
export interface ConversationAttribute {
|
|
30
|
+
/**
|
|
31
|
+
* Stable machine identifier used as the key in conversation.customAttributes.
|
|
32
|
+
*/
|
|
33
|
+
id: string;
|
|
34
|
+
/**
|
|
35
|
+
* Whether this definition has been archived.
|
|
36
|
+
*/
|
|
37
|
+
archived: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Storage-level data type used for validation and search.
|
|
40
|
+
*/
|
|
41
|
+
dataType: 'string' | 'number' | 'boolean' | 'date' | 'array' | 'object';
|
|
42
|
+
/**
|
|
43
|
+
* Conversation field subtype that controls the expected value shape.
|
|
44
|
+
*/
|
|
45
|
+
fieldSubType: 'text' | 'number' | 'select' | 'multi-select' | 'checkbox' | 'date';
|
|
46
|
+
/**
|
|
47
|
+
* Stable internal identifier for the attribute definition.
|
|
48
|
+
*/
|
|
49
|
+
identifier: string;
|
|
50
|
+
/**
|
|
51
|
+
* Human-readable attribute name shown in Featurebase.
|
|
52
|
+
*/
|
|
53
|
+
name: string;
|
|
54
|
+
/**
|
|
55
|
+
* Object type identifier
|
|
56
|
+
*/
|
|
57
|
+
object: 'conversation_attribute';
|
|
58
|
+
/**
|
|
59
|
+
* ISO timestamp when the attribute was created.
|
|
60
|
+
*/
|
|
61
|
+
createdAt?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Allowed values for select and multi-select attributes.
|
|
64
|
+
*/
|
|
65
|
+
options?: Array<ConversationAttributeOption>;
|
|
66
|
+
/**
|
|
67
|
+
* ISO timestamp when the attribute was last updated.
|
|
68
|
+
*/
|
|
69
|
+
updatedAt?: string;
|
|
70
|
+
}
|
|
71
|
+
export interface ConversationAttributeOption {
|
|
72
|
+
/**
|
|
73
|
+
* Option display label
|
|
74
|
+
*/
|
|
75
|
+
label: string;
|
|
76
|
+
/**
|
|
77
|
+
* Option unique identifier when stored for this option.
|
|
78
|
+
*/
|
|
79
|
+
id?: string;
|
|
80
|
+
}
|
|
81
|
+
export interface ConversationAttributeListResponse {
|
|
82
|
+
/**
|
|
83
|
+
* Array of conversation custom attribute definitions.
|
|
84
|
+
*/
|
|
85
|
+
data: Array<ConversationAttribute>;
|
|
86
|
+
/**
|
|
87
|
+
* Cursor for fetching the next page. Always null; all definitions are returned at
|
|
88
|
+
* once.
|
|
89
|
+
*/
|
|
90
|
+
nextCursor: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Object type identifier
|
|
93
|
+
*/
|
|
94
|
+
object: 'list';
|
|
95
|
+
}
|
|
96
|
+
export interface ConversationAttributeListParams {
|
|
97
|
+
/**
|
|
98
|
+
* Query param: Include archived conversation custom attributes in the response.
|
|
99
|
+
*/
|
|
100
|
+
includeArchived?: boolean | 'true' | 'false';
|
|
101
|
+
/**
|
|
102
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
103
|
+
* configured API version if not specified.
|
|
104
|
+
*/
|
|
105
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
106
|
+
}
|
|
107
|
+
export interface ConversationAttributeRetrieveParams {
|
|
108
|
+
/**
|
|
109
|
+
* API version for this request. Defaults to your organization's configured API
|
|
110
|
+
* version if not specified.
|
|
111
|
+
*/
|
|
112
|
+
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
113
|
+
}
|
|
114
|
+
export declare namespace ConversationAttributes {
|
|
115
|
+
export { type ConversationAttribute as ConversationAttribute, type ConversationAttributeOption as ConversationAttributeOption, type ConversationAttributeListResponse as ConversationAttributeListResponse, type ConversationAttributeListParams as ConversationAttributeListParams, type ConversationAttributeRetrieveParams as ConversationAttributeRetrieveParams, };
|
|
116
|
+
}
|
|
117
|
+
//# sourceMappingURL=conversation-attributes.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversation-attributes.d.mts","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAgBhD;;;;;;OAMG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAcrC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAExE;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,CAAC;IAElF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
|