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 @@
|
|
|
1
|
+
{"version":3,"file":"articles.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/articles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAYlF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAYtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAY9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAYlC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAUrC;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CACnB,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CACP,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EACV,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CACpB,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CACP,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;QAEzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,OAAO,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEzC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,EAAE,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEpC,OAAO,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAEzC,OAAO,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;KAC1C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,YAAY,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,OAAO,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAElD,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,OAAO,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAElD,OAAO,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;KACnD;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEzB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,OAAO,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAElD,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,EAAE,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAE7C,OAAO,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;QAElD,OAAO,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAC;KACnD;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,296 @@
|
|
|
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.Articles = 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
|
+
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
10
|
+
*/
|
|
11
|
+
class Articles extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* Creates a new article in your organization's help center.
|
|
14
|
+
*
|
|
15
|
+
* ### Request Body
|
|
16
|
+
*
|
|
17
|
+
* Required attributes:
|
|
18
|
+
*
|
|
19
|
+
* - `title` - The title of the article
|
|
20
|
+
*
|
|
21
|
+
* Optional attributes:
|
|
22
|
+
*
|
|
23
|
+
* - `description` - A brief description of the article
|
|
24
|
+
* - `body` - The HTML content of the article (supports external image URLs and
|
|
25
|
+
* base64 data URIs)
|
|
26
|
+
* - `formatter` - Content formatter: "default" or "ai" (AI converts markdown/html
|
|
27
|
+
* to Featurebase format)
|
|
28
|
+
* - `parentId` - The ID of the parent collection
|
|
29
|
+
* - `icon` - Icon object with type and value
|
|
30
|
+
* - `state` - "live" or "draft" (defaults to "draft")
|
|
31
|
+
* - `translations` - Dictionary of translations keyed by locale
|
|
32
|
+
*
|
|
33
|
+
* ### Response
|
|
34
|
+
*
|
|
35
|
+
* Returns the created article object with:
|
|
36
|
+
*
|
|
37
|
+
* - `id` - Unique identifier
|
|
38
|
+
* - `title` - Article title
|
|
39
|
+
* - `description` - Article description
|
|
40
|
+
* - `body` - Article content (HTML)
|
|
41
|
+
* - `slug` - URL slug
|
|
42
|
+
* - `icon` - Article icon (emoji or custom)
|
|
43
|
+
* - `parentId` - Parent collection ID
|
|
44
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
45
|
+
* - `organization` - Organization ID
|
|
46
|
+
* - `state` - Article state (live or draft)
|
|
47
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
48
|
+
* - `translations` - Translations for different locales
|
|
49
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
50
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const article = await client.helpCenter.articles.create({
|
|
55
|
+
* title: 'Getting Started Guide',
|
|
56
|
+
* });
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
create(params, options) {
|
|
60
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
61
|
+
return this._client.post('/v2/help_center/articles', {
|
|
62
|
+
body,
|
|
63
|
+
...options,
|
|
64
|
+
headers: (0, headers_1.buildHeaders)([
|
|
65
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
66
|
+
options?.headers,
|
|
67
|
+
]),
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Retrieves a specific article by its unique identifier.
|
|
72
|
+
*
|
|
73
|
+
* Returns the article object if found in your organization's help center.
|
|
74
|
+
*
|
|
75
|
+
* ### Query Parameters
|
|
76
|
+
*
|
|
77
|
+
* - `state` - Article state to retrieve: "live" or "draft" (default "live")
|
|
78
|
+
*
|
|
79
|
+
* ### Response
|
|
80
|
+
*
|
|
81
|
+
* Returns an article object with:
|
|
82
|
+
*
|
|
83
|
+
* - `id` - Unique identifier
|
|
84
|
+
* - `title` - Article title
|
|
85
|
+
* - `description` - Article description
|
|
86
|
+
* - `body` - Article content (HTML)
|
|
87
|
+
* - `slug` - URL slug
|
|
88
|
+
* - `icon` - Article icon (emoji or custom)
|
|
89
|
+
* - `parentId` - Parent collection ID
|
|
90
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
91
|
+
* - `organization` - Organization ID
|
|
92
|
+
* - `state` - Article state (live or draft)
|
|
93
|
+
* - `defaultLocale` - Default locale for content
|
|
94
|
+
* - `locale` - Current locale
|
|
95
|
+
* - `availableLocales` - Array of available locales
|
|
96
|
+
* - `publishedLocales` - Array of locales where article is published
|
|
97
|
+
* - `featurebaseUrl` - Featurebase URL for the article
|
|
98
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
99
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
100
|
+
* - `order` - Display order
|
|
101
|
+
* - `isPublished` - Whether the article is published
|
|
102
|
+
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
103
|
+
* - `translations` - Translations for different locales
|
|
104
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
105
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
106
|
+
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
107
|
+
*
|
|
108
|
+
* ### Errors
|
|
109
|
+
*
|
|
110
|
+
* - `404` - Article not found in your organization's help center
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const article = await client.helpCenter.articles.retrieve(
|
|
115
|
+
* '1234567',
|
|
116
|
+
* );
|
|
117
|
+
* ```
|
|
118
|
+
*/
|
|
119
|
+
retrieve(id, params = {}, options) {
|
|
120
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
121
|
+
return this._client.get((0, path_1.path) `/v2/help_center/articles/${id}`, {
|
|
122
|
+
query,
|
|
123
|
+
...options,
|
|
124
|
+
headers: (0, headers_1.buildHeaders)([
|
|
125
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
126
|
+
options?.headers,
|
|
127
|
+
]),
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Updates an existing article. Only include the fields you wish to update.
|
|
132
|
+
*
|
|
133
|
+
* ### Path Parameters
|
|
134
|
+
*
|
|
135
|
+
* - `id` - The unique identifier of the article to update
|
|
136
|
+
*
|
|
137
|
+
* ### Request Body
|
|
138
|
+
*
|
|
139
|
+
* All fields are optional. Only provided fields will be updated:
|
|
140
|
+
*
|
|
141
|
+
* - `title` - The new title of the article
|
|
142
|
+
* - `description` - The new description of the article
|
|
143
|
+
* - `body` - The new HTML content of the article
|
|
144
|
+
* - `formatter` - Content formatter: "default" or "ai"
|
|
145
|
+
* - `icon` - Updated icon object for the article
|
|
146
|
+
* - `parentId` - New parent collection ID
|
|
147
|
+
* - `authorId` - ID of the new author (must be a member of the organization)
|
|
148
|
+
* - `state` - "live" or "draft" - if "live", publishes immediately
|
|
149
|
+
* - `translations` - Dictionary of updated translations keyed by locale
|
|
150
|
+
*
|
|
151
|
+
* ### Response
|
|
152
|
+
*
|
|
153
|
+
* Returns the updated article object with:
|
|
154
|
+
*
|
|
155
|
+
* - `id` - Unique identifier
|
|
156
|
+
* - `title` - Article title
|
|
157
|
+
* - `description` - Article description
|
|
158
|
+
* - `body` - Article content (HTML)
|
|
159
|
+
* - `slug` - URL slug
|
|
160
|
+
* - `icon` - Article icon (emoji or custom)
|
|
161
|
+
* - `parentId` - Parent collection ID
|
|
162
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
163
|
+
* - `organization` - Organization ID
|
|
164
|
+
* - `state` - Article state (live or draft)
|
|
165
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
166
|
+
* - `translations` - Translations for different locales
|
|
167
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
168
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
169
|
+
*
|
|
170
|
+
* ### Errors
|
|
171
|
+
*
|
|
172
|
+
* - `404` - Article not found in your organization's help center
|
|
173
|
+
*
|
|
174
|
+
* @example
|
|
175
|
+
* ```ts
|
|
176
|
+
* const article = await client.helpCenter.articles.update(
|
|
177
|
+
* '1234567',
|
|
178
|
+
* );
|
|
179
|
+
* ```
|
|
180
|
+
*/
|
|
181
|
+
update(id, params, options) {
|
|
182
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
183
|
+
return this._client.patch((0, path_1.path) `/v2/help_center/articles/${id}`, {
|
|
184
|
+
body,
|
|
185
|
+
...options,
|
|
186
|
+
headers: (0, headers_1.buildHeaders)([
|
|
187
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
188
|
+
options?.headers,
|
|
189
|
+
]),
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Returns a paginated list of articles within your organization's help center.
|
|
194
|
+
*
|
|
195
|
+
* Articles are the main content pieces that contain documentation, guides, and
|
|
196
|
+
* FAQs.
|
|
197
|
+
*
|
|
198
|
+
* ### Query Parameters
|
|
199
|
+
*
|
|
200
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
201
|
+
* - `cursor` - Cursor for pagination
|
|
202
|
+
* - `state` - Filter by article state: "live", "draft", or "all" (default "live")
|
|
203
|
+
* - `parentId` - Filter by parent collection ID
|
|
204
|
+
*
|
|
205
|
+
* ### Response Format
|
|
206
|
+
*
|
|
207
|
+
* Returns a list object with:
|
|
208
|
+
*
|
|
209
|
+
* - `object` - Always "list"
|
|
210
|
+
* - `data` - Array of article objects
|
|
211
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
212
|
+
*
|
|
213
|
+
* ### Article Object
|
|
214
|
+
*
|
|
215
|
+
* Each article includes:
|
|
216
|
+
*
|
|
217
|
+
* - `id` - Unique identifier
|
|
218
|
+
* - `title` - Article title
|
|
219
|
+
* - `description` - Article description
|
|
220
|
+
* - `body` - Article content (HTML)
|
|
221
|
+
* - `slug` - URL slug
|
|
222
|
+
* - `icon` - Article icon (emoji or custom)
|
|
223
|
+
* - `parentId` - Parent collection ID
|
|
224
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
225
|
+
* - `organization` - Organization ID
|
|
226
|
+
* - `state` - Article state (live or draft)
|
|
227
|
+
* - `defaultLocale` - Default locale for content
|
|
228
|
+
* - `locale` - Current locale
|
|
229
|
+
* - `availableLocales` - Array of available locales
|
|
230
|
+
* - `publishedLocales` - Array of locales where article is published
|
|
231
|
+
* - `featurebaseUrl` - Featurebase URL for the article
|
|
232
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
233
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
234
|
+
* - `order` - Display order
|
|
235
|
+
* - `isPublished` - Whether the article is published
|
|
236
|
+
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
237
|
+
* - `translations` - Translations for different locales
|
|
238
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
239
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
240
|
+
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
241
|
+
*
|
|
242
|
+
* @example
|
|
243
|
+
* ```ts
|
|
244
|
+
* const articles = await client.helpCenter.articles.list();
|
|
245
|
+
* ```
|
|
246
|
+
*/
|
|
247
|
+
list(params = {}, options) {
|
|
248
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
249
|
+
return this._client.get('/v2/help_center/articles', {
|
|
250
|
+
query,
|
|
251
|
+
...options,
|
|
252
|
+
headers: (0, headers_1.buildHeaders)([
|
|
253
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
254
|
+
options?.headers,
|
|
255
|
+
]),
|
|
256
|
+
});
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Deletes an existing article.
|
|
260
|
+
*
|
|
261
|
+
* ### Path Parameters
|
|
262
|
+
*
|
|
263
|
+
* - `id` - The unique identifier of the article to delete
|
|
264
|
+
*
|
|
265
|
+
* ### Response
|
|
266
|
+
*
|
|
267
|
+
* Returns a deletion confirmation object:
|
|
268
|
+
*
|
|
269
|
+
* - `id` - The ID of the deleted article
|
|
270
|
+
* - `object` - Always "article"
|
|
271
|
+
* - `deleted` - Always true
|
|
272
|
+
*
|
|
273
|
+
* ### Errors
|
|
274
|
+
*
|
|
275
|
+
* - `404` - Article not found in your organization's help center
|
|
276
|
+
*
|
|
277
|
+
* @example
|
|
278
|
+
* ```ts
|
|
279
|
+
* const article = await client.helpCenter.articles.delete(
|
|
280
|
+
* '1234567',
|
|
281
|
+
* );
|
|
282
|
+
* ```
|
|
283
|
+
*/
|
|
284
|
+
delete(id, params = {}, options) {
|
|
285
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
286
|
+
return this._client.delete((0, path_1.path) `/v2/help_center/articles/${id}`, {
|
|
287
|
+
...options,
|
|
288
|
+
headers: (0, headers_1.buildHeaders)([
|
|
289
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
290
|
+
options?.headers,
|
|
291
|
+
]),
|
|
292
|
+
});
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
exports.Articles = Articles;
|
|
296
|
+
//# sourceMappingURL=articles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"articles.js","sourceRoot":"","sources":["../../src/resources/help-center/articles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE;YAC5D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAClD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE;YAC/D,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;AA1SD,4BA0SC"}
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
7
|
+
*/
|
|
8
|
+
export class Articles extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Creates a new article in your organization's help center.
|
|
11
|
+
*
|
|
12
|
+
* ### Request Body
|
|
13
|
+
*
|
|
14
|
+
* Required attributes:
|
|
15
|
+
*
|
|
16
|
+
* - `title` - The title of the article
|
|
17
|
+
*
|
|
18
|
+
* Optional attributes:
|
|
19
|
+
*
|
|
20
|
+
* - `description` - A brief description of the article
|
|
21
|
+
* - `body` - The HTML content of the article (supports external image URLs and
|
|
22
|
+
* base64 data URIs)
|
|
23
|
+
* - `formatter` - Content formatter: "default" or "ai" (AI converts markdown/html
|
|
24
|
+
* to Featurebase format)
|
|
25
|
+
* - `parentId` - The ID of the parent collection
|
|
26
|
+
* - `icon` - Icon object with type and value
|
|
27
|
+
* - `state` - "live" or "draft" (defaults to "draft")
|
|
28
|
+
* - `translations` - Dictionary of translations keyed by locale
|
|
29
|
+
*
|
|
30
|
+
* ### Response
|
|
31
|
+
*
|
|
32
|
+
* Returns the created article object with:
|
|
33
|
+
*
|
|
34
|
+
* - `id` - Unique identifier
|
|
35
|
+
* - `title` - Article title
|
|
36
|
+
* - `description` - Article description
|
|
37
|
+
* - `body` - Article content (HTML)
|
|
38
|
+
* - `slug` - URL slug
|
|
39
|
+
* - `icon` - Article icon (emoji or custom)
|
|
40
|
+
* - `parentId` - Parent collection ID
|
|
41
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
42
|
+
* - `organization` - Organization ID
|
|
43
|
+
* - `state` - Article state (live or draft)
|
|
44
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
45
|
+
* - `translations` - Translations for different locales
|
|
46
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
47
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const article = await client.helpCenter.articles.create({
|
|
52
|
+
* title: 'Getting Started Guide',
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
create(params, options) {
|
|
57
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
58
|
+
return this._client.post('/v2/help_center/articles', {
|
|
59
|
+
body,
|
|
60
|
+
...options,
|
|
61
|
+
headers: buildHeaders([
|
|
62
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
63
|
+
options?.headers,
|
|
64
|
+
]),
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Retrieves a specific article by its unique identifier.
|
|
69
|
+
*
|
|
70
|
+
* Returns the article object if found in your organization's help center.
|
|
71
|
+
*
|
|
72
|
+
* ### Query Parameters
|
|
73
|
+
*
|
|
74
|
+
* - `state` - Article state to retrieve: "live" or "draft" (default "live")
|
|
75
|
+
*
|
|
76
|
+
* ### Response
|
|
77
|
+
*
|
|
78
|
+
* Returns an article object with:
|
|
79
|
+
*
|
|
80
|
+
* - `id` - Unique identifier
|
|
81
|
+
* - `title` - Article title
|
|
82
|
+
* - `description` - Article description
|
|
83
|
+
* - `body` - Article content (HTML)
|
|
84
|
+
* - `slug` - URL slug
|
|
85
|
+
* - `icon` - Article icon (emoji or custom)
|
|
86
|
+
* - `parentId` - Parent collection ID
|
|
87
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
88
|
+
* - `organization` - Organization ID
|
|
89
|
+
* - `state` - Article state (live or draft)
|
|
90
|
+
* - `defaultLocale` - Default locale for content
|
|
91
|
+
* - `locale` - Current locale
|
|
92
|
+
* - `availableLocales` - Array of available locales
|
|
93
|
+
* - `publishedLocales` - Array of locales where article is published
|
|
94
|
+
* - `featurebaseUrl` - Featurebase URL for the article
|
|
95
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
96
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
97
|
+
* - `order` - Display order
|
|
98
|
+
* - `isPublished` - Whether the article is published
|
|
99
|
+
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
100
|
+
* - `translations` - Translations for different locales
|
|
101
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
102
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
103
|
+
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
104
|
+
*
|
|
105
|
+
* ### Errors
|
|
106
|
+
*
|
|
107
|
+
* - `404` - Article not found in your organization's help center
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* const article = await client.helpCenter.articles.retrieve(
|
|
112
|
+
* '1234567',
|
|
113
|
+
* );
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
retrieve(id, params = {}, options) {
|
|
117
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
118
|
+
return this._client.get(path `/v2/help_center/articles/${id}`, {
|
|
119
|
+
query,
|
|
120
|
+
...options,
|
|
121
|
+
headers: buildHeaders([
|
|
122
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
123
|
+
options?.headers,
|
|
124
|
+
]),
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Updates an existing article. Only include the fields you wish to update.
|
|
129
|
+
*
|
|
130
|
+
* ### Path Parameters
|
|
131
|
+
*
|
|
132
|
+
* - `id` - The unique identifier of the article to update
|
|
133
|
+
*
|
|
134
|
+
* ### Request Body
|
|
135
|
+
*
|
|
136
|
+
* All fields are optional. Only provided fields will be updated:
|
|
137
|
+
*
|
|
138
|
+
* - `title` - The new title of the article
|
|
139
|
+
* - `description` - The new description of the article
|
|
140
|
+
* - `body` - The new HTML content of the article
|
|
141
|
+
* - `formatter` - Content formatter: "default" or "ai"
|
|
142
|
+
* - `icon` - Updated icon object for the article
|
|
143
|
+
* - `parentId` - New parent collection ID
|
|
144
|
+
* - `authorId` - ID of the new author (must be a member of the organization)
|
|
145
|
+
* - `state` - "live" or "draft" - if "live", publishes immediately
|
|
146
|
+
* - `translations` - Dictionary of updated translations keyed by locale
|
|
147
|
+
*
|
|
148
|
+
* ### Response
|
|
149
|
+
*
|
|
150
|
+
* Returns the updated article object with:
|
|
151
|
+
*
|
|
152
|
+
* - `id` - Unique identifier
|
|
153
|
+
* - `title` - Article title
|
|
154
|
+
* - `description` - Article description
|
|
155
|
+
* - `body` - Article content (HTML)
|
|
156
|
+
* - `slug` - URL slug
|
|
157
|
+
* - `icon` - Article icon (emoji or custom)
|
|
158
|
+
* - `parentId` - Parent collection ID
|
|
159
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
160
|
+
* - `organization` - Organization ID
|
|
161
|
+
* - `state` - Article state (live or draft)
|
|
162
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
163
|
+
* - `translations` - Translations for different locales
|
|
164
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
165
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
166
|
+
*
|
|
167
|
+
* ### Errors
|
|
168
|
+
*
|
|
169
|
+
* - `404` - Article not found in your organization's help center
|
|
170
|
+
*
|
|
171
|
+
* @example
|
|
172
|
+
* ```ts
|
|
173
|
+
* const article = await client.helpCenter.articles.update(
|
|
174
|
+
* '1234567',
|
|
175
|
+
* );
|
|
176
|
+
* ```
|
|
177
|
+
*/
|
|
178
|
+
update(id, params, options) {
|
|
179
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
180
|
+
return this._client.patch(path `/v2/help_center/articles/${id}`, {
|
|
181
|
+
body,
|
|
182
|
+
...options,
|
|
183
|
+
headers: buildHeaders([
|
|
184
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
185
|
+
options?.headers,
|
|
186
|
+
]),
|
|
187
|
+
});
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Returns a paginated list of articles within your organization's help center.
|
|
191
|
+
*
|
|
192
|
+
* Articles are the main content pieces that contain documentation, guides, and
|
|
193
|
+
* FAQs.
|
|
194
|
+
*
|
|
195
|
+
* ### Query Parameters
|
|
196
|
+
*
|
|
197
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
198
|
+
* - `cursor` - Cursor for pagination
|
|
199
|
+
* - `state` - Filter by article state: "live", "draft", or "all" (default "live")
|
|
200
|
+
* - `parentId` - Filter by parent collection ID
|
|
201
|
+
*
|
|
202
|
+
* ### Response Format
|
|
203
|
+
*
|
|
204
|
+
* Returns a list object with:
|
|
205
|
+
*
|
|
206
|
+
* - `object` - Always "list"
|
|
207
|
+
* - `data` - Array of article objects
|
|
208
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
209
|
+
*
|
|
210
|
+
* ### Article Object
|
|
211
|
+
*
|
|
212
|
+
* Each article includes:
|
|
213
|
+
*
|
|
214
|
+
* - `id` - Unique identifier
|
|
215
|
+
* - `title` - Article title
|
|
216
|
+
* - `description` - Article description
|
|
217
|
+
* - `body` - Article content (HTML)
|
|
218
|
+
* - `slug` - URL slug
|
|
219
|
+
* - `icon` - Article icon (emoji or custom)
|
|
220
|
+
* - `parentId` - Parent collection ID
|
|
221
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
222
|
+
* - `organization` - Organization ID
|
|
223
|
+
* - `state` - Article state (live or draft)
|
|
224
|
+
* - `defaultLocale` - Default locale for content
|
|
225
|
+
* - `locale` - Current locale
|
|
226
|
+
* - `availableLocales` - Array of available locales
|
|
227
|
+
* - `publishedLocales` - Array of locales where article is published
|
|
228
|
+
* - `featurebaseUrl` - Featurebase URL for the article
|
|
229
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
230
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
231
|
+
* - `order` - Display order
|
|
232
|
+
* - `isPublished` - Whether the article is published
|
|
233
|
+
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
234
|
+
* - `translations` - Translations for different locales
|
|
235
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
236
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
237
|
+
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
238
|
+
*
|
|
239
|
+
* @example
|
|
240
|
+
* ```ts
|
|
241
|
+
* const articles = await client.helpCenter.articles.list();
|
|
242
|
+
* ```
|
|
243
|
+
*/
|
|
244
|
+
list(params = {}, options) {
|
|
245
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
246
|
+
return this._client.get('/v2/help_center/articles', {
|
|
247
|
+
query,
|
|
248
|
+
...options,
|
|
249
|
+
headers: buildHeaders([
|
|
250
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
251
|
+
options?.headers,
|
|
252
|
+
]),
|
|
253
|
+
});
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Deletes an existing article.
|
|
257
|
+
*
|
|
258
|
+
* ### Path Parameters
|
|
259
|
+
*
|
|
260
|
+
* - `id` - The unique identifier of the article to delete
|
|
261
|
+
*
|
|
262
|
+
* ### Response
|
|
263
|
+
*
|
|
264
|
+
* Returns a deletion confirmation object:
|
|
265
|
+
*
|
|
266
|
+
* - `id` - The ID of the deleted article
|
|
267
|
+
* - `object` - Always "article"
|
|
268
|
+
* - `deleted` - Always true
|
|
269
|
+
*
|
|
270
|
+
* ### Errors
|
|
271
|
+
*
|
|
272
|
+
* - `404` - Article not found in your organization's help center
|
|
273
|
+
*
|
|
274
|
+
* @example
|
|
275
|
+
* ```ts
|
|
276
|
+
* const article = await client.helpCenter.articles.delete(
|
|
277
|
+
* '1234567',
|
|
278
|
+
* );
|
|
279
|
+
* ```
|
|
280
|
+
*/
|
|
281
|
+
delete(id, params = {}, options) {
|
|
282
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
283
|
+
return this._client.delete(path `/v2/help_center/articles/${id}`, {
|
|
284
|
+
...options,
|
|
285
|
+
headers: buildHeaders([
|
|
286
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
287
|
+
options?.headers,
|
|
288
|
+
]),
|
|
289
|
+
});
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
//# sourceMappingURL=articles.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"articles.mjs","sourceRoot":"","sources":["../../src/resources/help-center/articles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE;YAC5D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAClD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE;YAC/D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|