featurebase-node 0.0.2
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 +10 -0
- package/LICENSE +201 -0
- package/README.md +356 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +274 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +274 -0
- package/client.d.ts.map +1 -0
- package/client.js +569 -0
- package/client.js.map +1 -0
- package/client.mjs +565 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +40 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +37 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/query.d.mts +2 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +2 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +10 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +6 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +8 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +8 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +12 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +9 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +143 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/admins.d.mts +437 -0
- package/resources/admins.d.mts.map +1 -0
- package/resources/admins.d.ts +437 -0
- package/resources/admins.d.ts.map +1 -0
- package/resources/admins.js +157 -0
- package/resources/admins.js.map +1 -0
- package/resources/admins.mjs +153 -0
- package/resources/admins.mjs.map +1 -0
- package/resources/boards.d.mts +202 -0
- package/resources/boards.d.mts.map +1 -0
- package/resources/boards.d.ts +202 -0
- package/resources/boards.d.ts.map +1 -0
- package/resources/boards.js +52 -0
- package/resources/boards.js.map +1 -0
- package/resources/boards.mjs +48 -0
- package/resources/boards.mjs.map +1 -0
- package/resources/brands.d.mts +180 -0
- package/resources/brands.d.mts.map +1 -0
- package/resources/brands.d.ts +180 -0
- package/resources/brands.d.ts.map +1 -0
- package/resources/brands.js +130 -0
- package/resources/brands.js.map +1 -0
- package/resources/brands.mjs +126 -0
- package/resources/brands.mjs.map +1 -0
- package/resources/changelogs/changelogs.d.mts +723 -0
- package/resources/changelogs/changelogs.d.mts.map +1 -0
- package/resources/changelogs/changelogs.d.ts +723 -0
- package/resources/changelogs/changelogs.d.ts.map +1 -0
- package/resources/changelogs/changelogs.js +406 -0
- package/resources/changelogs/changelogs.js.map +1 -0
- package/resources/changelogs/changelogs.mjs +401 -0
- package/resources/changelogs/changelogs.mjs.map +1 -0
- package/resources/changelogs/index.d.mts +3 -0
- package/resources/changelogs/index.d.mts.map +1 -0
- package/resources/changelogs/index.d.ts +3 -0
- package/resources/changelogs/index.d.ts.map +1 -0
- package/resources/changelogs/index.js +9 -0
- package/resources/changelogs/index.js.map +1 -0
- package/resources/changelogs/index.mjs +4 -0
- package/resources/changelogs/index.mjs.map +1 -0
- package/resources/changelogs/subscribers.d.mts +145 -0
- package/resources/changelogs/subscribers.d.mts.map +1 -0
- package/resources/changelogs/subscribers.d.ts +145 -0
- package/resources/changelogs/subscribers.d.ts.map +1 -0
- package/resources/changelogs/subscribers.js +119 -0
- package/resources/changelogs/subscribers.js.map +1 -0
- package/resources/changelogs/subscribers.mjs +115 -0
- package/resources/changelogs/subscribers.mjs.map +1 -0
- package/resources/changelogs.d.mts +2 -0
- package/resources/changelogs.d.mts.map +1 -0
- package/resources/changelogs.d.ts +2 -0
- package/resources/changelogs.d.ts.map +1 -0
- package/resources/changelogs.js +6 -0
- package/resources/changelogs.js.map +1 -0
- package/resources/changelogs.mjs +3 -0
- package/resources/changelogs.mjs.map +1 -0
- package/resources/comments.d.mts +632 -0
- package/resources/comments.d.mts.map +1 -0
- package/resources/comments.d.ts +632 -0
- package/resources/comments.d.ts.map +1 -0
- package/resources/comments.js +397 -0
- package/resources/comments.js.map +1 -0
- package/resources/comments.mjs +393 -0
- package/resources/comments.mjs.map +1 -0
- package/resources/companies/companies.d.mts +497 -0
- package/resources/companies/companies.d.mts.map +1 -0
- package/resources/companies/companies.d.ts +497 -0
- package/resources/companies/companies.d.ts.map +1 -0
- package/resources/companies/companies.js +368 -0
- package/resources/companies/companies.js.map +1 -0
- package/resources/companies/companies.mjs +363 -0
- package/resources/companies/companies.mjs.map +1 -0
- package/resources/companies/contacts.d.mts +236 -0
- package/resources/companies/contacts.d.mts.map +1 -0
- package/resources/companies/contacts.d.ts +236 -0
- package/resources/companies/contacts.d.ts.map +1 -0
- package/resources/companies/contacts.js +218 -0
- package/resources/companies/contacts.js.map +1 -0
- package/resources/companies/contacts.mjs +214 -0
- package/resources/companies/contacts.mjs.map +1 -0
- package/resources/companies/index.d.mts +3 -0
- package/resources/companies/index.d.mts.map +1 -0
- package/resources/companies/index.d.ts +3 -0
- package/resources/companies/index.d.ts.map +1 -0
- package/resources/companies/index.js +9 -0
- package/resources/companies/index.js.map +1 -0
- package/resources/companies/index.mjs +4 -0
- package/resources/companies/index.mjs.map +1 -0
- package/resources/companies.d.mts +2 -0
- package/resources/companies.d.mts.map +1 -0
- package/resources/companies.d.ts +2 -0
- package/resources/companies.d.ts.map +1 -0
- package/resources/companies.js +6 -0
- package/resources/companies.js.map +1 -0
- package/resources/companies.mjs +3 -0
- package/resources/companies.mjs.map +1 -0
- package/resources/contacts/by-user-id/by-user-id.d.mts +147 -0
- package/resources/contacts/by-user-id/by-user-id.d.mts.map +1 -0
- package/resources/contacts/by-user-id/by-user-id.d.ts +147 -0
- package/resources/contacts/by-user-id/by-user-id.d.ts.map +1 -0
- package/resources/contacts/by-user-id/by-user-id.js +152 -0
- package/resources/contacts/by-user-id/by-user-id.js.map +1 -0
- package/resources/contacts/by-user-id/by-user-id.mjs +147 -0
- package/resources/contacts/by-user-id/by-user-id.mjs.map +1 -0
- package/resources/contacts/by-user-id/email-preferences.d.mts +199 -0
- package/resources/contacts/by-user-id/email-preferences.d.mts.map +1 -0
- package/resources/contacts/by-user-id/email-preferences.d.ts +199 -0
- package/resources/contacts/by-user-id/email-preferences.d.ts.map +1 -0
- package/resources/contacts/by-user-id/email-preferences.js +176 -0
- package/resources/contacts/by-user-id/email-preferences.js.map +1 -0
- package/resources/contacts/by-user-id/email-preferences.mjs +172 -0
- package/resources/contacts/by-user-id/email-preferences.mjs.map +1 -0
- package/resources/contacts/by-user-id/index.d.mts +3 -0
- package/resources/contacts/by-user-id/index.d.mts.map +1 -0
- package/resources/contacts/by-user-id/index.d.ts +3 -0
- package/resources/contacts/by-user-id/index.d.ts.map +1 -0
- package/resources/contacts/by-user-id/index.js +9 -0
- package/resources/contacts/by-user-id/index.js.map +1 -0
- package/resources/contacts/by-user-id/index.mjs +4 -0
- package/resources/contacts/by-user-id/index.mjs.map +1 -0
- package/resources/contacts/by-user-id.d.mts +2 -0
- package/resources/contacts/by-user-id.d.mts.map +1 -0
- package/resources/contacts/by-user-id.d.ts +2 -0
- package/resources/contacts/by-user-id.d.ts.map +1 -0
- package/resources/contacts/by-user-id.js +6 -0
- package/resources/contacts/by-user-id.js.map +1 -0
- package/resources/contacts/by-user-id.mjs +3 -0
- package/resources/contacts/by-user-id.mjs.map +1 -0
- package/resources/contacts/contacts.d.mts +708 -0
- package/resources/contacts/contacts.d.mts.map +1 -0
- package/resources/contacts/contacts.d.ts +708 -0
- package/resources/contacts/contacts.d.ts.map +1 -0
- package/resources/contacts/contacts.js +444 -0
- package/resources/contacts/contacts.js.map +1 -0
- package/resources/contacts/contacts.mjs +439 -0
- package/resources/contacts/contacts.mjs.map +1 -0
- package/resources/contacts/email-preferences.d.mts +334 -0
- package/resources/contacts/email-preferences.d.mts.map +1 -0
- package/resources/contacts/email-preferences.d.ts +334 -0
- package/resources/contacts/email-preferences.d.ts.map +1 -0
- package/resources/contacts/email-preferences.js +219 -0
- package/resources/contacts/email-preferences.js.map +1 -0
- package/resources/contacts/email-preferences.mjs +215 -0
- package/resources/contacts/email-preferences.mjs.map +1 -0
- package/resources/contacts/index.d.mts +4 -0
- package/resources/contacts/index.d.mts.map +1 -0
- package/resources/contacts/index.d.ts +4 -0
- package/resources/contacts/index.d.ts.map +1 -0
- package/resources/contacts/index.js +11 -0
- package/resources/contacts/index.js.map +1 -0
- package/resources/contacts/index.mjs +5 -0
- package/resources/contacts/index.mjs.map +1 -0
- package/resources/contacts.d.mts +2 -0
- package/resources/contacts.d.mts.map +1 -0
- package/resources/contacts.d.ts +2 -0
- package/resources/contacts.d.ts.map +1 -0
- package/resources/contacts.js +6 -0
- package/resources/contacts.js.map +1 -0
- package/resources/contacts.mjs +3 -0
- package/resources/contacts.mjs.map +1 -0
- package/resources/conversations/conversations.d.mts +2235 -0
- package/resources/conversations/conversations.d.mts.map +1 -0
- package/resources/conversations/conversations.d.ts +2235 -0
- package/resources/conversations/conversations.d.ts.map +1 -0
- package/resources/conversations/conversations.js +753 -0
- package/resources/conversations/conversations.js.map +1 -0
- package/resources/conversations/conversations.mjs +748 -0
- package/resources/conversations/conversations.mjs.map +1 -0
- package/resources/conversations/index.d.mts +4 -0
- package/resources/conversations/index.d.mts.map +1 -0
- package/resources/conversations/index.d.ts +4 -0
- package/resources/conversations/index.d.ts.map +1 -0
- package/resources/conversations/index.js +11 -0
- package/resources/conversations/index.js.map +1 -0
- package/resources/conversations/index.mjs +5 -0
- package/resources/conversations/index.mjs.map +1 -0
- package/resources/conversations/participants.d.mts +217 -0
- package/resources/conversations/participants.d.mts.map +1 -0
- package/resources/conversations/participants.d.ts +217 -0
- package/resources/conversations/participants.d.ts.map +1 -0
- package/resources/conversations/participants.js +185 -0
- package/resources/conversations/participants.js.map +1 -0
- package/resources/conversations/participants.mjs +181 -0
- package/resources/conversations/participants.mjs.map +1 -0
- package/resources/conversations/tags.d.mts +200 -0
- package/resources/conversations/tags.d.mts.map +1 -0
- package/resources/conversations/tags.d.ts +200 -0
- package/resources/conversations/tags.d.ts.map +1 -0
- package/resources/conversations/tags.js +138 -0
- package/resources/conversations/tags.js.map +1 -0
- package/resources/conversations/tags.mjs +134 -0
- package/resources/conversations/tags.mjs.map +1 -0
- package/resources/conversations.d.mts +2 -0
- package/resources/conversations.d.mts.map +1 -0
- package/resources/conversations.d.ts +2 -0
- package/resources/conversations.d.ts.map +1 -0
- package/resources/conversations.js +6 -0
- package/resources/conversations.js.map +1 -0
- package/resources/conversations.mjs +3 -0
- package/resources/conversations.mjs.map +1 -0
- package/resources/custom-fields.d.mts +189 -0
- package/resources/custom-fields.d.mts.map +1 -0
- package/resources/custom-fields.d.ts +189 -0
- package/resources/custom-fields.d.ts.map +1 -0
- package/resources/custom-fields.js +92 -0
- package/resources/custom-fields.js.map +1 -0
- package/resources/custom-fields.mjs +88 -0
- package/resources/custom-fields.mjs.map +1 -0
- package/resources/help-center/articles.d.mts +770 -0
- package/resources/help-center/articles.d.mts.map +1 -0
- package/resources/help-center/articles.d.ts +770 -0
- package/resources/help-center/articles.d.ts.map +1 -0
- package/resources/help-center/articles.js +296 -0
- package/resources/help-center/articles.js.map +1 -0
- package/resources/help-center/articles.mjs +292 -0
- package/resources/help-center/articles.mjs.map +1 -0
- package/resources/help-center/collections.d.mts +669 -0
- package/resources/help-center/collections.d.mts.map +1 -0
- package/resources/help-center/collections.d.ts +669 -0
- package/resources/help-center/collections.d.ts.map +1 -0
- package/resources/help-center/collections.js +278 -0
- package/resources/help-center/collections.js.map +1 -0
- package/resources/help-center/collections.mjs +274 -0
- package/resources/help-center/collections.mjs.map +1 -0
- package/resources/help-center/help-center.d.mts +22 -0
- package/resources/help-center/help-center.d.mts.map +1 -0
- package/resources/help-center/help-center.d.ts +22 -0
- package/resources/help-center/help-center.d.ts.map +1 -0
- package/resources/help-center/help-center.js +29 -0
- package/resources/help-center/help-center.js.map +1 -0
- package/resources/help-center/help-center.mjs +24 -0
- package/resources/help-center/help-center.mjs.map +1 -0
- package/resources/help-center/help-centers.d.mts +312 -0
- package/resources/help-center/help-centers.d.mts.map +1 -0
- package/resources/help-center/help-centers.d.ts +312 -0
- package/resources/help-center/help-centers.d.ts.map +1 -0
- package/resources/help-center/help-centers.js +111 -0
- package/resources/help-center/help-centers.js.map +1 -0
- package/resources/help-center/help-centers.mjs +107 -0
- package/resources/help-center/help-centers.mjs.map +1 -0
- package/resources/help-center/index.d.mts +6 -0
- package/resources/help-center/index.d.mts.map +1 -0
- package/resources/help-center/index.d.ts +6 -0
- package/resources/help-center/index.d.ts.map +1 -0
- package/resources/help-center/index.js +15 -0
- package/resources/help-center/index.js.map +1 -0
- package/resources/help-center/index.mjs +7 -0
- package/resources/help-center/index.mjs.map +1 -0
- package/resources/help-center/redirect-rules.d.mts +417 -0
- package/resources/help-center/redirect-rules.d.mts.map +1 -0
- package/resources/help-center/redirect-rules.d.ts +417 -0
- package/resources/help-center/redirect-rules.d.ts.map +1 -0
- package/resources/help-center/redirect-rules.js +297 -0
- package/resources/help-center/redirect-rules.js.map +1 -0
- package/resources/help-center/redirect-rules.mjs +293 -0
- package/resources/help-center/redirect-rules.mjs.map +1 -0
- package/resources/help-center.d.mts +2 -0
- package/resources/help-center.d.mts.map +1 -0
- package/resources/help-center.d.ts +2 -0
- package/resources/help-center.d.ts.map +1 -0
- package/resources/help-center.js +6 -0
- package/resources/help-center.js.map +1 -0
- package/resources/help-center.mjs +3 -0
- package/resources/help-center.mjs.map +1 -0
- package/resources/index.d.mts +18 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +18 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +39 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +19 -0
- package/resources/index.mjs.map +1 -0
- package/resources/post-statuses.d.mts +74 -0
- package/resources/post-statuses.d.mts.map +1 -0
- package/resources/post-statuses.d.ts +74 -0
- package/resources/post-statuses.d.ts.map +1 -0
- package/resources/post-statuses.js +53 -0
- package/resources/post-statuses.js.map +1 -0
- package/resources/post-statuses.mjs +49 -0
- package/resources/post-statuses.mjs.map +1 -0
- package/resources/posts/index.d.mts +3 -0
- package/resources/posts/index.d.mts.map +1 -0
- package/resources/posts/index.d.ts +3 -0
- package/resources/posts/index.d.ts.map +1 -0
- package/resources/posts/index.js +9 -0
- package/resources/posts/index.js.map +1 -0
- package/resources/posts/index.mjs +4 -0
- package/resources/posts/index.mjs.map +1 -0
- package/resources/posts/posts.d.mts +799 -0
- package/resources/posts/posts.d.mts.map +1 -0
- package/resources/posts/posts.d.ts +799 -0
- package/resources/posts/posts.d.ts.map +1 -0
- package/resources/posts/posts.js +271 -0
- package/resources/posts/posts.js.map +1 -0
- package/resources/posts/posts.mjs +266 -0
- package/resources/posts/posts.mjs.map +1 -0
- package/resources/posts/voters.d.mts +359 -0
- package/resources/posts/voters.d.mts.map +1 -0
- package/resources/posts/voters.d.ts +359 -0
- package/resources/posts/voters.d.ts.map +1 -0
- package/resources/posts/voters.js +171 -0
- package/resources/posts/voters.js.map +1 -0
- package/resources/posts/voters.mjs +167 -0
- package/resources/posts/voters.mjs.map +1 -0
- package/resources/posts.d.mts +2 -0
- package/resources/posts.d.mts.map +1 -0
- package/resources/posts.d.ts +2 -0
- package/resources/posts.d.ts.map +1 -0
- package/resources/posts.js +6 -0
- package/resources/posts.js.map +1 -0
- package/resources/posts.mjs +3 -0
- package/resources/posts.mjs.map +1 -0
- package/resources/surveys.d.mts +451 -0
- package/resources/surveys.d.mts.map +1 -0
- package/resources/surveys.d.ts +451 -0
- package/resources/surveys.d.ts.map +1 -0
- package/resources/surveys.js +149 -0
- package/resources/surveys.js.map +1 -0
- package/resources/surveys.mjs +145 -0
- package/resources/surveys.mjs.map +1 -0
- package/resources/tags.d.mts +147 -0
- package/resources/tags.d.mts.map +1 -0
- package/resources/tags.d.ts +147 -0
- package/resources/tags.d.ts.map +1 -0
- package/resources/tags.js +100 -0
- package/resources/tags.js.map +1 -0
- package/resources/tags.mjs +96 -0
- package/resources/tags.mjs.map +1 -0
- package/resources/teams.d.mts +165 -0
- package/resources/teams.d.mts.map +1 -0
- package/resources/teams.d.ts +165 -0
- package/resources/teams.d.ts.map +1 -0
- package/resources/teams.js +120 -0
- package/resources/teams.js.map +1 -0
- package/resources/teams.mjs +116 -0
- package/resources/teams.mjs.map +1 -0
- package/resources/tickets/categories.d.mts +63 -0
- package/resources/tickets/categories.d.mts.map +1 -0
- package/resources/tickets/categories.d.ts +63 -0
- package/resources/tickets/categories.d.ts.map +1 -0
- package/resources/tickets/categories.js +67 -0
- package/resources/tickets/categories.js.map +1 -0
- package/resources/tickets/categories.mjs +63 -0
- package/resources/tickets/categories.mjs.map +1 -0
- package/resources/tickets/custom-fields.d.mts +80 -0
- package/resources/tickets/custom-fields.d.mts.map +1 -0
- package/resources/tickets/custom-fields.d.ts +80 -0
- package/resources/tickets/custom-fields.d.ts.map +1 -0
- package/resources/tickets/custom-fields.js +85 -0
- package/resources/tickets/custom-fields.js.map +1 -0
- package/resources/tickets/custom-fields.mjs +81 -0
- package/resources/tickets/custom-fields.mjs.map +1 -0
- package/resources/tickets/index.d.mts +5 -0
- package/resources/tickets/index.d.mts.map +1 -0
- package/resources/tickets/index.d.ts +5 -0
- package/resources/tickets/index.d.ts.map +1 -0
- package/resources/tickets/index.js +13 -0
- package/resources/tickets/index.js.map +1 -0
- package/resources/tickets/index.mjs +6 -0
- package/resources/tickets/index.mjs.map +1 -0
- package/resources/tickets/statuses.d.mts +59 -0
- package/resources/tickets/statuses.d.mts.map +1 -0
- package/resources/tickets/statuses.d.ts +59 -0
- package/resources/tickets/statuses.d.ts.map +1 -0
- package/resources/tickets/statuses.js +63 -0
- package/resources/tickets/statuses.js.map +1 -0
- package/resources/tickets/statuses.mjs +59 -0
- package/resources/tickets/statuses.mjs.map +1 -0
- package/resources/tickets/tickets.d.mts +794 -0
- package/resources/tickets/tickets.d.mts.map +1 -0
- package/resources/tickets/tickets.d.ts +794 -0
- package/resources/tickets/tickets.d.ts.map +1 -0
- package/resources/tickets/tickets.js +327 -0
- package/resources/tickets/tickets.js.map +1 -0
- package/resources/tickets/tickets.mjs +322 -0
- package/resources/tickets/tickets.mjs.map +1 -0
- package/resources/tickets.d.mts +2 -0
- package/resources/tickets.d.mts.map +1 -0
- package/resources/tickets.d.ts +2 -0
- package/resources/tickets.d.ts.map +1 -0
- package/resources/tickets.js +6 -0
- package/resources/tickets.js.map +1 -0
- package/resources/tickets.mjs +3 -0
- package/resources/tickets.mjs.map +1 -0
- package/resources/webhooks.d.mts +626 -0
- package/resources/webhooks.d.mts.map +1 -0
- package/resources/webhooks.d.ts +626 -0
- package/resources/webhooks.d.ts.map +1 -0
- package/resources/webhooks.js +442 -0
- package/resources/webhooks.js.map +1 -0
- package/resources/webhooks.mjs +438 -0
- package/resources/webhooks.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +1169 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +56 -0
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/query.ts +7 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +9 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/admins.ts +557 -0
- package/src/resources/boards.ts +259 -0
- package/src/resources/brands.ts +232 -0
- package/src/resources/changelogs/changelogs.ts +1139 -0
- package/src/resources/changelogs/index.ts +23 -0
- package/src/resources/changelogs/subscribers.ts +226 -0
- package/src/resources/changelogs.ts +3 -0
- package/src/resources/comments.ts +786 -0
- package/src/resources/companies/companies.ts +632 -0
- package/src/resources/companies/contacts.ts +299 -0
- package/src/resources/companies/index.ts +21 -0
- package/src/resources/companies.ts +3 -0
- package/src/resources/contacts/by-user-id/by-user-id.ts +200 -0
- package/src/resources/contacts/by-user-id/email-preferences.ts +243 -0
- package/src/resources/contacts/by-user-id/index.ts +13 -0
- package/src/resources/contacts/by-user-id.ts +3 -0
- package/src/resources/contacts/contacts.ts +908 -0
- package/src/resources/contacts/email-preferences.ts +399 -0
- package/src/resources/contacts/index.ts +32 -0
- package/src/resources/contacts.ts +3 -0
- package/src/resources/conversations/conversations.ts +2721 -0
- package/src/resources/conversations/index.ts +31 -0
- package/src/resources/conversations/participants.ts +263 -0
- package/src/resources/conversations/tags.ts +252 -0
- package/src/resources/conversations.ts +3 -0
- package/src/resources/custom-fields.ts +249 -0
- package/src/resources/help-center/articles.ts +1231 -0
- package/src/resources/help-center/collections.ts +1065 -0
- package/src/resources/help-center/help-center.ts +125 -0
- package/src/resources/help-center/help-centers.ts +558 -0
- package/src/resources/help-center/index.ts +52 -0
- package/src/resources/help-center/redirect-rules.ts +711 -0
- package/src/resources/help-center.ts +3 -0
- package/src/resources/index.ts +179 -0
- package/src/resources/post-statuses.ts +119 -0
- package/src/resources/posts/index.ts +22 -0
- package/src/resources/posts/posts.ts +1019 -0
- package/src/resources/posts/voters.ts +453 -0
- package/src/resources/posts.ts +3 -0
- package/src/resources/surveys.ts +576 -0
- package/src/resources/tags.ts +226 -0
- package/src/resources/teams.ts +213 -0
- package/src/resources/tickets/categories.ts +101 -0
- package/src/resources/tickets/custom-fields.ts +116 -0
- package/src/resources/tickets/index.ts +28 -0
- package/src/resources/tickets/statuses.ts +97 -0
- package/src/resources/tickets/tickets.ts +1019 -0
- package/src/resources/tickets.ts +3 -0
- package/src/resources/webhooks.ts +850 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,437 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
/**
|
|
5
|
+
* Team members who manage your Featurebase organization. Admins have roles that define their permissions.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Admins extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a single admin by their unique identifier.
|
|
10
|
+
*
|
|
11
|
+
* Returns the admin object if found and they belong to your organization.
|
|
12
|
+
*
|
|
13
|
+
* ### Response
|
|
14
|
+
*
|
|
15
|
+
* Returns an admin object with:
|
|
16
|
+
*
|
|
17
|
+
* - `id` - Unique admin identifier
|
|
18
|
+
* - `name` - Admin's display name
|
|
19
|
+
* - `email` - Admin's email address
|
|
20
|
+
* - `picture` - Profile picture URL
|
|
21
|
+
* - `roleId` - ID of the role assigned to this admin
|
|
22
|
+
*
|
|
23
|
+
* ### Errors
|
|
24
|
+
*
|
|
25
|
+
* - `404` - Admin not found or doesn't belong to your organization
|
|
26
|
+
*/
|
|
27
|
+
retrieve(id: string, params?: AdminRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Admin>;
|
|
28
|
+
/**
|
|
29
|
+
* Returns all admins for your organization.
|
|
30
|
+
*
|
|
31
|
+
* This endpoint returns all admins at once (typically a small list). No pagination
|
|
32
|
+
* is supported.
|
|
33
|
+
*
|
|
34
|
+
* ### Response Format
|
|
35
|
+
*
|
|
36
|
+
* Returns a list object with:
|
|
37
|
+
*
|
|
38
|
+
* - `object` - Always "list"
|
|
39
|
+
* - `data` - Array of admin objects
|
|
40
|
+
* - `nextCursor` - Always null
|
|
41
|
+
*
|
|
42
|
+
* ### Admin Object
|
|
43
|
+
*
|
|
44
|
+
* Each admin includes:
|
|
45
|
+
*
|
|
46
|
+
* - `id` - Unique admin identifier
|
|
47
|
+
* - `name` - Admin's display name
|
|
48
|
+
* - `email` - Admin's email address
|
|
49
|
+
* - `picture` - Profile picture URL
|
|
50
|
+
* - `roleId` - ID of the role assigned to this admin
|
|
51
|
+
*/
|
|
52
|
+
list(params?: AdminListParams | null | undefined, options?: RequestOptions): APIPromise<AdminListResponse>;
|
|
53
|
+
/**
|
|
54
|
+
* Returns all available admin roles and their permissions.
|
|
55
|
+
*
|
|
56
|
+
* This endpoint returns all roles at once (typically a small list). No pagination
|
|
57
|
+
* is supported.
|
|
58
|
+
*
|
|
59
|
+
* ### Response Format
|
|
60
|
+
*
|
|
61
|
+
* Returns a list object with:
|
|
62
|
+
*
|
|
63
|
+
* - `object` - Always "list"
|
|
64
|
+
* - `data` - Array of admin role objects
|
|
65
|
+
* - `nextCursor` - Always null
|
|
66
|
+
*
|
|
67
|
+
* ### Admin Role Object
|
|
68
|
+
*
|
|
69
|
+
* Each role includes:
|
|
70
|
+
*
|
|
71
|
+
* - `id` - Unique role identifier
|
|
72
|
+
* - `name` - Role name (e.g., "Admin", "Viewer")
|
|
73
|
+
* - `permissions` - Object containing permission flags
|
|
74
|
+
*
|
|
75
|
+
* ### Permissions
|
|
76
|
+
*
|
|
77
|
+
* The permissions object contains boolean flags for each permission:
|
|
78
|
+
*
|
|
79
|
+
* - `view_comments_private` - Can view private comments
|
|
80
|
+
* - `manage_comments` - Can manage comments
|
|
81
|
+
* - `manage_comments_private` - Can manage private comments
|
|
82
|
+
* - `set_comment_pinned` - Can pin comments
|
|
83
|
+
* - `moderate_comments` - Can moderate comments
|
|
84
|
+
* - `set_post_category` - Can change post categories
|
|
85
|
+
* - `set_post_pinned` - Can pin posts
|
|
86
|
+
* - `set_post_eta` - Can set post ETA
|
|
87
|
+
* - `set_post_tags` - Can manage post tags
|
|
88
|
+
* - `set_post_author` - Can change post author
|
|
89
|
+
* - `set_post_status` - Can change post status
|
|
90
|
+
* - `set_post_assignee` - Can assign posts
|
|
91
|
+
* - `set_post_custom_fields` - Can edit custom fields
|
|
92
|
+
* - `post_vote_on_behalf` - Can vote on behalf of users
|
|
93
|
+
* - `post_merge` - Can merge posts
|
|
94
|
+
* - `post_import` - Can import posts
|
|
95
|
+
* - `post_export` - Can export posts
|
|
96
|
+
* - `moderate_posts` - Can moderate posts
|
|
97
|
+
* - `view_users` - Can view users
|
|
98
|
+
* - `manage_users` - Can manage users
|
|
99
|
+
* - `view_posts_private` - Can view private posts
|
|
100
|
+
* - `view_private_post_tags` - Can view private tags
|
|
101
|
+
* - `manage_changelogs` - Can manage changelogs
|
|
102
|
+
* - `manage_surveys` - Can manage surveys
|
|
103
|
+
* - `manage_branding` - Can manage branding
|
|
104
|
+
* - `manage_billing` - Can manage billing
|
|
105
|
+
* - `manage_team_members` - Can manage team members
|
|
106
|
+
* - `manage_sso` - Can manage SSO settings
|
|
107
|
+
* - `manage_api` - Can manage API settings
|
|
108
|
+
* - `manage_statuses` - Can manage statuses
|
|
109
|
+
* - `manage_boards` - Can manage boards
|
|
110
|
+
* - `manage_post_tags` - Can manage post tags
|
|
111
|
+
* - `manage_custom_fields` - Can manage custom fields
|
|
112
|
+
* - `manage_moderation_settings` - Can manage moderation
|
|
113
|
+
* - `manage_roadmap` - Can manage roadmap
|
|
114
|
+
* - `manage_user_roles` - Can manage user roles
|
|
115
|
+
* - `manage_prioritization` - Can manage prioritization
|
|
116
|
+
* - `manage_notifications` - Can manage notifications
|
|
117
|
+
* - `manage_custom_domain` - Can manage custom domain
|
|
118
|
+
* - `manage_integrations` - Can manage integrations
|
|
119
|
+
* - `use_integrations` - Can use integrations
|
|
120
|
+
* - `manage_help_center` - Can manage help center
|
|
121
|
+
* - `auto_approve_posts` - Posts auto-approved
|
|
122
|
+
*/
|
|
123
|
+
listRoles(params?: AdminListRolesParams | null | undefined, options?: RequestOptions): APIPromise<AdminListRolesResponse>;
|
|
124
|
+
}
|
|
125
|
+
export interface Admin {
|
|
126
|
+
/**
|
|
127
|
+
* Unique identifier
|
|
128
|
+
*/
|
|
129
|
+
id: string;
|
|
130
|
+
/**
|
|
131
|
+
* Object type identifier
|
|
132
|
+
*/
|
|
133
|
+
object: 'admin';
|
|
134
|
+
/**
|
|
135
|
+
* Admin email address
|
|
136
|
+
*/
|
|
137
|
+
email?: string;
|
|
138
|
+
/**
|
|
139
|
+
* Admin display name
|
|
140
|
+
*/
|
|
141
|
+
name?: string;
|
|
142
|
+
/**
|
|
143
|
+
* Profile picture URL
|
|
144
|
+
*/
|
|
145
|
+
profilePicture?: string | null;
|
|
146
|
+
/**
|
|
147
|
+
* Role ID assigned to this admin
|
|
148
|
+
*/
|
|
149
|
+
roleId?: string;
|
|
150
|
+
}
|
|
151
|
+
export interface AdminListResponse {
|
|
152
|
+
/**
|
|
153
|
+
* Array of admins
|
|
154
|
+
*/
|
|
155
|
+
data: Array<Admin>;
|
|
156
|
+
/**
|
|
157
|
+
* Cursor for fetching the next page (cursor-based pagination)
|
|
158
|
+
*/
|
|
159
|
+
nextCursor: string | null;
|
|
160
|
+
/**
|
|
161
|
+
* Object type identifier
|
|
162
|
+
*/
|
|
163
|
+
object: 'list';
|
|
164
|
+
/**
|
|
165
|
+
* Pagination metadata for page-based requests
|
|
166
|
+
*/
|
|
167
|
+
pagination?: AdminListResponse.Pagination;
|
|
168
|
+
}
|
|
169
|
+
export declare namespace AdminListResponse {
|
|
170
|
+
/**
|
|
171
|
+
* Pagination metadata for page-based requests
|
|
172
|
+
*/
|
|
173
|
+
interface Pagination {
|
|
174
|
+
/**
|
|
175
|
+
* Items per page
|
|
176
|
+
*/
|
|
177
|
+
limit: number;
|
|
178
|
+
/**
|
|
179
|
+
* Current page number
|
|
180
|
+
*/
|
|
181
|
+
page: number;
|
|
182
|
+
/**
|
|
183
|
+
* Total number of items
|
|
184
|
+
*/
|
|
185
|
+
total: number;
|
|
186
|
+
/**
|
|
187
|
+
* Total number of pages
|
|
188
|
+
*/
|
|
189
|
+
totalPages: number;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
export interface AdminListRolesResponse {
|
|
193
|
+
/**
|
|
194
|
+
* Array of admin roles
|
|
195
|
+
*/
|
|
196
|
+
data: Array<AdminListRolesResponse.Data>;
|
|
197
|
+
/**
|
|
198
|
+
* Cursor for fetching the next page (cursor-based pagination)
|
|
199
|
+
*/
|
|
200
|
+
nextCursor: string | null;
|
|
201
|
+
/**
|
|
202
|
+
* Object type identifier
|
|
203
|
+
*/
|
|
204
|
+
object: 'list';
|
|
205
|
+
}
|
|
206
|
+
export declare namespace AdminListRolesResponse {
|
|
207
|
+
interface Data {
|
|
208
|
+
/**
|
|
209
|
+
* Role unique identifier
|
|
210
|
+
*/
|
|
211
|
+
id: string;
|
|
212
|
+
/**
|
|
213
|
+
* Role name
|
|
214
|
+
*/
|
|
215
|
+
name: string;
|
|
216
|
+
/**
|
|
217
|
+
* Object type identifier
|
|
218
|
+
*/
|
|
219
|
+
object: 'admin_role';
|
|
220
|
+
/**
|
|
221
|
+
* Role permissions
|
|
222
|
+
*/
|
|
223
|
+
permissions: Data.Permissions;
|
|
224
|
+
}
|
|
225
|
+
namespace Data {
|
|
226
|
+
/**
|
|
227
|
+
* Role permissions
|
|
228
|
+
*/
|
|
229
|
+
interface Permissions {
|
|
230
|
+
/**
|
|
231
|
+
* Auto-approve posts
|
|
232
|
+
*/
|
|
233
|
+
auto_approve_posts?: boolean;
|
|
234
|
+
/**
|
|
235
|
+
* Manage API settings
|
|
236
|
+
*/
|
|
237
|
+
manage_api?: boolean;
|
|
238
|
+
/**
|
|
239
|
+
* Manage billing
|
|
240
|
+
*/
|
|
241
|
+
manage_billing?: boolean;
|
|
242
|
+
/**
|
|
243
|
+
* Manage boards
|
|
244
|
+
*/
|
|
245
|
+
manage_boards?: boolean;
|
|
246
|
+
/**
|
|
247
|
+
* Manage branding
|
|
248
|
+
*/
|
|
249
|
+
manage_branding?: boolean;
|
|
250
|
+
/**
|
|
251
|
+
* Manage changelogs
|
|
252
|
+
*/
|
|
253
|
+
manage_changelogs?: boolean;
|
|
254
|
+
/**
|
|
255
|
+
* Manage comments
|
|
256
|
+
*/
|
|
257
|
+
manage_comments?: boolean;
|
|
258
|
+
/**
|
|
259
|
+
* Manage private comments
|
|
260
|
+
*/
|
|
261
|
+
manage_comments_private?: boolean;
|
|
262
|
+
/**
|
|
263
|
+
* Manage conversation tag definitions
|
|
264
|
+
*/
|
|
265
|
+
manage_conversation_tags?: boolean;
|
|
266
|
+
/**
|
|
267
|
+
* Manage custom domain
|
|
268
|
+
*/
|
|
269
|
+
manage_custom_domain?: boolean;
|
|
270
|
+
/**
|
|
271
|
+
* Manage custom fields
|
|
272
|
+
*/
|
|
273
|
+
manage_custom_fields?: boolean;
|
|
274
|
+
/**
|
|
275
|
+
* Manage help center
|
|
276
|
+
*/
|
|
277
|
+
manage_help_center?: boolean;
|
|
278
|
+
/**
|
|
279
|
+
* Manage integrations
|
|
280
|
+
*/
|
|
281
|
+
manage_integrations?: boolean;
|
|
282
|
+
/**
|
|
283
|
+
* Manage moderation settings
|
|
284
|
+
*/
|
|
285
|
+
manage_moderation_settings?: boolean;
|
|
286
|
+
/**
|
|
287
|
+
* Manage notifications
|
|
288
|
+
*/
|
|
289
|
+
manage_notifications?: boolean;
|
|
290
|
+
/**
|
|
291
|
+
* Manage post tags
|
|
292
|
+
*/
|
|
293
|
+
manage_post_tags?: boolean;
|
|
294
|
+
/**
|
|
295
|
+
* Manage prioritization
|
|
296
|
+
*/
|
|
297
|
+
manage_prioritization?: boolean;
|
|
298
|
+
/**
|
|
299
|
+
* Manage roadmap
|
|
300
|
+
*/
|
|
301
|
+
manage_roadmap?: boolean;
|
|
302
|
+
/**
|
|
303
|
+
* Manage SSO
|
|
304
|
+
*/
|
|
305
|
+
manage_sso?: boolean;
|
|
306
|
+
/**
|
|
307
|
+
* Manage post statuses
|
|
308
|
+
*/
|
|
309
|
+
manage_statuses?: boolean;
|
|
310
|
+
/**
|
|
311
|
+
* Manage surveys
|
|
312
|
+
*/
|
|
313
|
+
manage_surveys?: boolean;
|
|
314
|
+
/**
|
|
315
|
+
* Manage team members
|
|
316
|
+
*/
|
|
317
|
+
manage_team_members?: boolean;
|
|
318
|
+
/**
|
|
319
|
+
* Manage user roles
|
|
320
|
+
*/
|
|
321
|
+
manage_user_roles?: boolean;
|
|
322
|
+
/**
|
|
323
|
+
* Manage users
|
|
324
|
+
*/
|
|
325
|
+
manage_users?: boolean;
|
|
326
|
+
/**
|
|
327
|
+
* Moderate comments
|
|
328
|
+
*/
|
|
329
|
+
moderate_comments?: boolean;
|
|
330
|
+
/**
|
|
331
|
+
* Moderate posts
|
|
332
|
+
*/
|
|
333
|
+
moderate_posts?: boolean;
|
|
334
|
+
/**
|
|
335
|
+
* Export posts
|
|
336
|
+
*/
|
|
337
|
+
post_export?: boolean;
|
|
338
|
+
/**
|
|
339
|
+
* Import posts
|
|
340
|
+
*/
|
|
341
|
+
post_import?: boolean;
|
|
342
|
+
/**
|
|
343
|
+
* Merge posts
|
|
344
|
+
*/
|
|
345
|
+
post_merge?: boolean;
|
|
346
|
+
/**
|
|
347
|
+
* Vote on posts on behalf of users
|
|
348
|
+
*/
|
|
349
|
+
post_vote_on_behalf?: boolean;
|
|
350
|
+
/**
|
|
351
|
+
* Pin/unpin comments
|
|
352
|
+
*/
|
|
353
|
+
set_comment_pinned?: boolean;
|
|
354
|
+
/**
|
|
355
|
+
* Apply and remove conversation tags
|
|
356
|
+
*/
|
|
357
|
+
set_conversation_tags?: boolean;
|
|
358
|
+
/**
|
|
359
|
+
* Assign posts
|
|
360
|
+
*/
|
|
361
|
+
set_post_assignee?: boolean;
|
|
362
|
+
/**
|
|
363
|
+
* Set post author
|
|
364
|
+
*/
|
|
365
|
+
set_post_author?: boolean;
|
|
366
|
+
/**
|
|
367
|
+
* Set post category/board
|
|
368
|
+
*/
|
|
369
|
+
set_post_category?: boolean;
|
|
370
|
+
/**
|
|
371
|
+
* Set post custom fields
|
|
372
|
+
*/
|
|
373
|
+
set_post_custom_fields?: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* Set post ETA
|
|
376
|
+
*/
|
|
377
|
+
set_post_eta?: boolean;
|
|
378
|
+
/**
|
|
379
|
+
* Pin/unpin posts
|
|
380
|
+
*/
|
|
381
|
+
set_post_pinned?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* Set post status
|
|
384
|
+
*/
|
|
385
|
+
set_post_status?: boolean;
|
|
386
|
+
/**
|
|
387
|
+
* Set post tags
|
|
388
|
+
*/
|
|
389
|
+
set_post_tags?: boolean;
|
|
390
|
+
/**
|
|
391
|
+
* Use integrations
|
|
392
|
+
*/
|
|
393
|
+
use_integrations?: boolean;
|
|
394
|
+
/**
|
|
395
|
+
* View private comments
|
|
396
|
+
*/
|
|
397
|
+
view_comments_private?: boolean;
|
|
398
|
+
/**
|
|
399
|
+
* View private posts
|
|
400
|
+
*/
|
|
401
|
+
view_posts_private?: boolean;
|
|
402
|
+
/**
|
|
403
|
+
* View private post tags
|
|
404
|
+
*/
|
|
405
|
+
view_private_post_tags?: boolean;
|
|
406
|
+
/**
|
|
407
|
+
* View users
|
|
408
|
+
*/
|
|
409
|
+
view_users?: boolean;
|
|
410
|
+
}
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
export interface AdminRetrieveParams {
|
|
414
|
+
/**
|
|
415
|
+
* API version for this request. Defaults to your organization's configured API
|
|
416
|
+
* version if not specified.
|
|
417
|
+
*/
|
|
418
|
+
'Featurebase-Version'?: string;
|
|
419
|
+
}
|
|
420
|
+
export interface AdminListParams {
|
|
421
|
+
/**
|
|
422
|
+
* API version for this request. Defaults to your organization's configured API
|
|
423
|
+
* version if not specified.
|
|
424
|
+
*/
|
|
425
|
+
'Featurebase-Version'?: string;
|
|
426
|
+
}
|
|
427
|
+
export interface AdminListRolesParams {
|
|
428
|
+
/**
|
|
429
|
+
* API version for this request. Defaults to your organization's configured API
|
|
430
|
+
* version if not specified.
|
|
431
|
+
*/
|
|
432
|
+
'Featurebase-Version'?: string;
|
|
433
|
+
}
|
|
434
|
+
export declare namespace Admins {
|
|
435
|
+
export { type Admin as Admin, type AdminListResponse as AdminListResponse, type AdminListRolesResponse as AdminListRolesResponse, type AdminRetrieveParams as AdminRetrieveParams, type AdminListParams as AdminListParams, type AdminListRolesParams as AdminListRolesParams, };
|
|
436
|
+
}
|
|
437
|
+
//# sourceMappingURL=admins.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"admins.d.ts","sourceRoot":"","sources":["../src/resources/admins.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAWpB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,SAAS,CACP,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAUtC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,YAAY,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;YAElC;;eAEG;YACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;YAEnC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Admins = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
/**
|
|
9
|
+
* Team members who manage your Featurebase organization. Admins have roles that define their permissions.
|
|
10
|
+
*/
|
|
11
|
+
class Admins extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* Retrieves a single admin by their unique identifier.
|
|
14
|
+
*
|
|
15
|
+
* Returns the admin object if found and they belong to your organization.
|
|
16
|
+
*
|
|
17
|
+
* ### Response
|
|
18
|
+
*
|
|
19
|
+
* Returns an admin object with:
|
|
20
|
+
*
|
|
21
|
+
* - `id` - Unique admin identifier
|
|
22
|
+
* - `name` - Admin's display name
|
|
23
|
+
* - `email` - Admin's email address
|
|
24
|
+
* - `picture` - Profile picture URL
|
|
25
|
+
* - `roleId` - ID of the role assigned to this admin
|
|
26
|
+
*
|
|
27
|
+
* ### Errors
|
|
28
|
+
*
|
|
29
|
+
* - `404` - Admin not found or doesn't belong to your organization
|
|
30
|
+
*/
|
|
31
|
+
retrieve(id, params = {}, options) {
|
|
32
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
33
|
+
return this._client.get((0, path_1.path) `/v2/admins/${id}`, {
|
|
34
|
+
...options,
|
|
35
|
+
headers: (0, headers_1.buildHeaders)([
|
|
36
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
37
|
+
options?.headers,
|
|
38
|
+
]),
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Returns all admins for your organization.
|
|
43
|
+
*
|
|
44
|
+
* This endpoint returns all admins at once (typically a small list). No pagination
|
|
45
|
+
* is supported.
|
|
46
|
+
*
|
|
47
|
+
* ### Response Format
|
|
48
|
+
*
|
|
49
|
+
* Returns a list object with:
|
|
50
|
+
*
|
|
51
|
+
* - `object` - Always "list"
|
|
52
|
+
* - `data` - Array of admin objects
|
|
53
|
+
* - `nextCursor` - Always null
|
|
54
|
+
*
|
|
55
|
+
* ### Admin Object
|
|
56
|
+
*
|
|
57
|
+
* Each admin includes:
|
|
58
|
+
*
|
|
59
|
+
* - `id` - Unique admin identifier
|
|
60
|
+
* - `name` - Admin's display name
|
|
61
|
+
* - `email` - Admin's email address
|
|
62
|
+
* - `picture` - Profile picture URL
|
|
63
|
+
* - `roleId` - ID of the role assigned to this admin
|
|
64
|
+
*/
|
|
65
|
+
list(params = {}, options) {
|
|
66
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
67
|
+
return this._client.get('/v2/admins', {
|
|
68
|
+
...options,
|
|
69
|
+
headers: (0, headers_1.buildHeaders)([
|
|
70
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
71
|
+
options?.headers,
|
|
72
|
+
]),
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Returns all available admin roles and their permissions.
|
|
77
|
+
*
|
|
78
|
+
* This endpoint returns all roles at once (typically a small list). No pagination
|
|
79
|
+
* is supported.
|
|
80
|
+
*
|
|
81
|
+
* ### Response Format
|
|
82
|
+
*
|
|
83
|
+
* Returns a list object with:
|
|
84
|
+
*
|
|
85
|
+
* - `object` - Always "list"
|
|
86
|
+
* - `data` - Array of admin role objects
|
|
87
|
+
* - `nextCursor` - Always null
|
|
88
|
+
*
|
|
89
|
+
* ### Admin Role Object
|
|
90
|
+
*
|
|
91
|
+
* Each role includes:
|
|
92
|
+
*
|
|
93
|
+
* - `id` - Unique role identifier
|
|
94
|
+
* - `name` - Role name (e.g., "Admin", "Viewer")
|
|
95
|
+
* - `permissions` - Object containing permission flags
|
|
96
|
+
*
|
|
97
|
+
* ### Permissions
|
|
98
|
+
*
|
|
99
|
+
* The permissions object contains boolean flags for each permission:
|
|
100
|
+
*
|
|
101
|
+
* - `view_comments_private` - Can view private comments
|
|
102
|
+
* - `manage_comments` - Can manage comments
|
|
103
|
+
* - `manage_comments_private` - Can manage private comments
|
|
104
|
+
* - `set_comment_pinned` - Can pin comments
|
|
105
|
+
* - `moderate_comments` - Can moderate comments
|
|
106
|
+
* - `set_post_category` - Can change post categories
|
|
107
|
+
* - `set_post_pinned` - Can pin posts
|
|
108
|
+
* - `set_post_eta` - Can set post ETA
|
|
109
|
+
* - `set_post_tags` - Can manage post tags
|
|
110
|
+
* - `set_post_author` - Can change post author
|
|
111
|
+
* - `set_post_status` - Can change post status
|
|
112
|
+
* - `set_post_assignee` - Can assign posts
|
|
113
|
+
* - `set_post_custom_fields` - Can edit custom fields
|
|
114
|
+
* - `post_vote_on_behalf` - Can vote on behalf of users
|
|
115
|
+
* - `post_merge` - Can merge posts
|
|
116
|
+
* - `post_import` - Can import posts
|
|
117
|
+
* - `post_export` - Can export posts
|
|
118
|
+
* - `moderate_posts` - Can moderate posts
|
|
119
|
+
* - `view_users` - Can view users
|
|
120
|
+
* - `manage_users` - Can manage users
|
|
121
|
+
* - `view_posts_private` - Can view private posts
|
|
122
|
+
* - `view_private_post_tags` - Can view private tags
|
|
123
|
+
* - `manage_changelogs` - Can manage changelogs
|
|
124
|
+
* - `manage_surveys` - Can manage surveys
|
|
125
|
+
* - `manage_branding` - Can manage branding
|
|
126
|
+
* - `manage_billing` - Can manage billing
|
|
127
|
+
* - `manage_team_members` - Can manage team members
|
|
128
|
+
* - `manage_sso` - Can manage SSO settings
|
|
129
|
+
* - `manage_api` - Can manage API settings
|
|
130
|
+
* - `manage_statuses` - Can manage statuses
|
|
131
|
+
* - `manage_boards` - Can manage boards
|
|
132
|
+
* - `manage_post_tags` - Can manage post tags
|
|
133
|
+
* - `manage_custom_fields` - Can manage custom fields
|
|
134
|
+
* - `manage_moderation_settings` - Can manage moderation
|
|
135
|
+
* - `manage_roadmap` - Can manage roadmap
|
|
136
|
+
* - `manage_user_roles` - Can manage user roles
|
|
137
|
+
* - `manage_prioritization` - Can manage prioritization
|
|
138
|
+
* - `manage_notifications` - Can manage notifications
|
|
139
|
+
* - `manage_custom_domain` - Can manage custom domain
|
|
140
|
+
* - `manage_integrations` - Can manage integrations
|
|
141
|
+
* - `use_integrations` - Can use integrations
|
|
142
|
+
* - `manage_help_center` - Can manage help center
|
|
143
|
+
* - `auto_approve_posts` - Posts auto-approved
|
|
144
|
+
*/
|
|
145
|
+
listRoles(params = {}, options) {
|
|
146
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
147
|
+
return this._client.get('/v2/admins/roles', {
|
|
148
|
+
...options,
|
|
149
|
+
headers: (0, headers_1.buildHeaders)([
|
|
150
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
151
|
+
options?.headers,
|
|
152
|
+
]),
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
exports.Admins = Admins;
|
|
157
|
+
//# sourceMappingURL=admins.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"admins.js","sourceRoot":"","sources":["../src/resources/admins.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YACpC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,SAAS,CACP,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAC1C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA5JD,wBA4JC"}
|