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,278 @@
|
|
|
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.Collections = 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 Collections extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* Creates a new collection in your organization's help center.
|
|
14
|
+
*
|
|
15
|
+
* ### Request Body
|
|
16
|
+
*
|
|
17
|
+
* Required attributes:
|
|
18
|
+
*
|
|
19
|
+
* - `name` - The name of the collection
|
|
20
|
+
*
|
|
21
|
+
* Optional attributes:
|
|
22
|
+
*
|
|
23
|
+
* - `description` - A description of the collection
|
|
24
|
+
* - `icon` - An icon object representing the collection icon (with type and value)
|
|
25
|
+
* - `parentId` - The ID of the parent collection, if any
|
|
26
|
+
* - `translations` - A dictionary of translations keyed by locale
|
|
27
|
+
*
|
|
28
|
+
* ### Response
|
|
29
|
+
*
|
|
30
|
+
* Returns the created collection object with:
|
|
31
|
+
*
|
|
32
|
+
* - `id` - Unique identifier
|
|
33
|
+
* - `name` - Collection name
|
|
34
|
+
* - `description` - Collection description
|
|
35
|
+
* - `slug` - URL slug
|
|
36
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
37
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
38
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
39
|
+
* - `organization` - Organization ID
|
|
40
|
+
* - `defaultLocale` - Default locale for content
|
|
41
|
+
* - `locale` - Current locale
|
|
42
|
+
* - `availableLocales` - Array of available locales
|
|
43
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
44
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
45
|
+
* - `articleCount` - Number of articles in this collection
|
|
46
|
+
* - `authorCount` - Number of authors who contributed
|
|
47
|
+
* - `order` - Display order
|
|
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 collection =
|
|
55
|
+
* await client.helpCenter.collections.create({
|
|
56
|
+
* name: 'English Collection',
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
create(params, options) {
|
|
61
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
62
|
+
return this._client.post('/v2/help_center/collections', {
|
|
63
|
+
body,
|
|
64
|
+
...options,
|
|
65
|
+
headers: (0, headers_1.buildHeaders)([
|
|
66
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
67
|
+
options?.headers,
|
|
68
|
+
]),
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Retrieves a specific collection by its unique identifier.
|
|
73
|
+
*
|
|
74
|
+
* Returns the collection object if found in your organization's help center.
|
|
75
|
+
*
|
|
76
|
+
* ### Response
|
|
77
|
+
*
|
|
78
|
+
* Returns a collection object with:
|
|
79
|
+
*
|
|
80
|
+
* - `id` - Unique identifier
|
|
81
|
+
* - `name` - Collection name
|
|
82
|
+
* - `description` - Collection description
|
|
83
|
+
* - `slug` - URL slug
|
|
84
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
85
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
86
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
87
|
+
* - `organization` - Organization ID
|
|
88
|
+
* - `defaultLocale` - Default locale for content
|
|
89
|
+
* - `locale` - Current locale
|
|
90
|
+
* - `availableLocales` - Array of available locales
|
|
91
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
92
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
93
|
+
* - `articleCount` - Number of articles in this collection
|
|
94
|
+
* - `authorCount` - Number of authors who contributed
|
|
95
|
+
* - `order` - Display order
|
|
96
|
+
* - `translations` - Translations for different locales
|
|
97
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
98
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
99
|
+
*
|
|
100
|
+
* ### Errors
|
|
101
|
+
*
|
|
102
|
+
* - `404` - Collection not found in your organization's help center
|
|
103
|
+
*
|
|
104
|
+
* @example
|
|
105
|
+
* ```ts
|
|
106
|
+
* const collection =
|
|
107
|
+
* await client.helpCenter.collections.retrieve('6474684');
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
retrieve(id, params = {}, options) {
|
|
111
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
112
|
+
return this._client.get((0, path_1.path) `/v2/help_center/collections/${id}`, {
|
|
113
|
+
...options,
|
|
114
|
+
headers: (0, headers_1.buildHeaders)([
|
|
115
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
116
|
+
options?.headers,
|
|
117
|
+
]),
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Updates an existing collection. Only include the fields you wish to update.
|
|
122
|
+
*
|
|
123
|
+
* ### Path Parameters
|
|
124
|
+
*
|
|
125
|
+
* - `id` - The unique identifier of the collection to update
|
|
126
|
+
*
|
|
127
|
+
* ### Request Body
|
|
128
|
+
*
|
|
129
|
+
* All fields are optional. Only provided fields will be updated:
|
|
130
|
+
*
|
|
131
|
+
* - `name` - The new name of the collection
|
|
132
|
+
* - `description` - The new description of the collection
|
|
133
|
+
* - `icon` - An updated icon object for the collection (with type and value)
|
|
134
|
+
* - `parentId` - The new parent collection ID, if applicable (null for root level)
|
|
135
|
+
* - `translations` - A dictionary of updated translations keyed by locale code
|
|
136
|
+
*
|
|
137
|
+
* ### Response
|
|
138
|
+
*
|
|
139
|
+
* Returns the updated collection object with:
|
|
140
|
+
*
|
|
141
|
+
* - `id` - Unique identifier
|
|
142
|
+
* - `name` - Collection name
|
|
143
|
+
* - `description` - Collection description
|
|
144
|
+
* - `slug` - URL slug
|
|
145
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
146
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
147
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
148
|
+
* - `organization` - Organization ID
|
|
149
|
+
* - `defaultLocale` - Default locale for content
|
|
150
|
+
* - `locale` - Current locale
|
|
151
|
+
* - `availableLocales` - Array of available locales
|
|
152
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
153
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
154
|
+
* - `articleCount` - Number of articles in this collection
|
|
155
|
+
* - `authorCount` - Number of authors who contributed
|
|
156
|
+
* - `order` - Display order
|
|
157
|
+
* - `translations` - Translations for different locales
|
|
158
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
159
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
160
|
+
*
|
|
161
|
+
* ### Errors
|
|
162
|
+
*
|
|
163
|
+
* - `404` - Collection not found in your organization's help center
|
|
164
|
+
*
|
|
165
|
+
* @example
|
|
166
|
+
* ```ts
|
|
167
|
+
* const collection =
|
|
168
|
+
* await client.helpCenter.collections.update('3416135');
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
update(id, params, options) {
|
|
172
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
173
|
+
return this._client.patch((0, path_1.path) `/v2/help_center/collections/${id}`, {
|
|
174
|
+
body,
|
|
175
|
+
...options,
|
|
176
|
+
headers: (0, headers_1.buildHeaders)([
|
|
177
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
178
|
+
options?.headers,
|
|
179
|
+
]),
|
|
180
|
+
});
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Returns a paginated list of collections within your organization's help center.
|
|
184
|
+
*
|
|
185
|
+
* Collections are used to organize articles into logical groups.
|
|
186
|
+
*
|
|
187
|
+
* ### Query Parameters
|
|
188
|
+
*
|
|
189
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
190
|
+
* - `cursor` - Cursor for pagination
|
|
191
|
+
*
|
|
192
|
+
* ### Response Format
|
|
193
|
+
*
|
|
194
|
+
* Returns a list object with:
|
|
195
|
+
*
|
|
196
|
+
* - `object` - Always "list"
|
|
197
|
+
* - `data` - Array of collection objects
|
|
198
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
199
|
+
*
|
|
200
|
+
* ### Collection Object
|
|
201
|
+
*
|
|
202
|
+
* Each collection includes:
|
|
203
|
+
*
|
|
204
|
+
* - `id` - Unique identifier
|
|
205
|
+
* - `name` - Collection name
|
|
206
|
+
* - `description` - Collection description
|
|
207
|
+
* - `slug` - URL slug
|
|
208
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
209
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
210
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
211
|
+
* - `organization` - Organization ID
|
|
212
|
+
* - `defaultLocale` - Default locale for content
|
|
213
|
+
* - `locale` - Current locale
|
|
214
|
+
* - `availableLocales` - Array of available locales
|
|
215
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
216
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
217
|
+
* - `articleCount` - Number of articles in this collection
|
|
218
|
+
* - `authorCount` - Number of authors who contributed
|
|
219
|
+
* - `order` - Display order
|
|
220
|
+
* - `translations` - Translations for different locales
|
|
221
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
222
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
223
|
+
*
|
|
224
|
+
* @example
|
|
225
|
+
* ```ts
|
|
226
|
+
* const collections =
|
|
227
|
+
* await client.helpCenter.collections.list();
|
|
228
|
+
* ```
|
|
229
|
+
*/
|
|
230
|
+
list(params = {}, options) {
|
|
231
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
232
|
+
return this._client.get('/v2/help_center/collections', {
|
|
233
|
+
query,
|
|
234
|
+
...options,
|
|
235
|
+
headers: (0, headers_1.buildHeaders)([
|
|
236
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
237
|
+
options?.headers,
|
|
238
|
+
]),
|
|
239
|
+
});
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Deletes an existing collection.
|
|
243
|
+
*
|
|
244
|
+
* ### Path Parameters
|
|
245
|
+
*
|
|
246
|
+
* - `id` - The unique identifier of the collection to delete
|
|
247
|
+
*
|
|
248
|
+
* ### Response
|
|
249
|
+
*
|
|
250
|
+
* Returns a deletion confirmation object:
|
|
251
|
+
*
|
|
252
|
+
* - `id` - The ID of the deleted collection
|
|
253
|
+
* - `object` - Always "collection"
|
|
254
|
+
* - `deleted` - Always true
|
|
255
|
+
*
|
|
256
|
+
* ### Errors
|
|
257
|
+
*
|
|
258
|
+
* - `404` - Collection not found in your organization's help center
|
|
259
|
+
*
|
|
260
|
+
* @example
|
|
261
|
+
* ```ts
|
|
262
|
+
* const collection =
|
|
263
|
+
* await client.helpCenter.collections.delete('3416135');
|
|
264
|
+
* ```
|
|
265
|
+
*/
|
|
266
|
+
delete(id, params = {}, options) {
|
|
267
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
268
|
+
return this._client.delete((0, path_1.path) `/v2/help_center/collections/${id}`, {
|
|
269
|
+
...options,
|
|
270
|
+
headers: (0, headers_1.buildHeaders)([
|
|
271
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
272
|
+
options?.headers,
|
|
273
|
+
]),
|
|
274
|
+
});
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
exports.Collections = Collections;
|
|
278
|
+
//# sourceMappingURL=collections.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/resources/help-center/collections.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACtD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,EAAU,EAAE,MAA8B,EAAE,OAAwB;QACzE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE;YACjE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE;YACrD,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CACJ,EAAU,EACV,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAxRD,kCAwRC"}
|
|
@@ -0,0 +1,274 @@
|
|
|
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 Collections extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Creates a new collection in your organization's help center.
|
|
11
|
+
*
|
|
12
|
+
* ### Request Body
|
|
13
|
+
*
|
|
14
|
+
* Required attributes:
|
|
15
|
+
*
|
|
16
|
+
* - `name` - The name of the collection
|
|
17
|
+
*
|
|
18
|
+
* Optional attributes:
|
|
19
|
+
*
|
|
20
|
+
* - `description` - A description of the collection
|
|
21
|
+
* - `icon` - An icon object representing the collection icon (with type and value)
|
|
22
|
+
* - `parentId` - The ID of the parent collection, if any
|
|
23
|
+
* - `translations` - A dictionary of translations keyed by locale
|
|
24
|
+
*
|
|
25
|
+
* ### Response
|
|
26
|
+
*
|
|
27
|
+
* Returns the created collection object with:
|
|
28
|
+
*
|
|
29
|
+
* - `id` - Unique identifier
|
|
30
|
+
* - `name` - Collection name
|
|
31
|
+
* - `description` - Collection description
|
|
32
|
+
* - `slug` - URL slug
|
|
33
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
34
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
35
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
36
|
+
* - `organization` - Organization ID
|
|
37
|
+
* - `defaultLocale` - Default locale for content
|
|
38
|
+
* - `locale` - Current locale
|
|
39
|
+
* - `availableLocales` - Array of available locales
|
|
40
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
41
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
42
|
+
* - `articleCount` - Number of articles in this collection
|
|
43
|
+
* - `authorCount` - Number of authors who contributed
|
|
44
|
+
* - `order` - Display order
|
|
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 collection =
|
|
52
|
+
* await client.helpCenter.collections.create({
|
|
53
|
+
* name: 'English Collection',
|
|
54
|
+
* });
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
create(params, options) {
|
|
58
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
59
|
+
return this._client.post('/v2/help_center/collections', {
|
|
60
|
+
body,
|
|
61
|
+
...options,
|
|
62
|
+
headers: buildHeaders([
|
|
63
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
64
|
+
options?.headers,
|
|
65
|
+
]),
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Retrieves a specific collection by its unique identifier.
|
|
70
|
+
*
|
|
71
|
+
* Returns the collection object if found in your organization's help center.
|
|
72
|
+
*
|
|
73
|
+
* ### Response
|
|
74
|
+
*
|
|
75
|
+
* Returns a collection object with:
|
|
76
|
+
*
|
|
77
|
+
* - `id` - Unique identifier
|
|
78
|
+
* - `name` - Collection name
|
|
79
|
+
* - `description` - Collection description
|
|
80
|
+
* - `slug` - URL slug
|
|
81
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
82
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
83
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
84
|
+
* - `organization` - Organization ID
|
|
85
|
+
* - `defaultLocale` - Default locale for content
|
|
86
|
+
* - `locale` - Current locale
|
|
87
|
+
* - `availableLocales` - Array of available locales
|
|
88
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
89
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
90
|
+
* - `articleCount` - Number of articles in this collection
|
|
91
|
+
* - `authorCount` - Number of authors who contributed
|
|
92
|
+
* - `order` - Display order
|
|
93
|
+
* - `translations` - Translations for different locales
|
|
94
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
95
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
96
|
+
*
|
|
97
|
+
* ### Errors
|
|
98
|
+
*
|
|
99
|
+
* - `404` - Collection not found in your organization's help center
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* const collection =
|
|
104
|
+
* await client.helpCenter.collections.retrieve('6474684');
|
|
105
|
+
* ```
|
|
106
|
+
*/
|
|
107
|
+
retrieve(id, params = {}, options) {
|
|
108
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
109
|
+
return this._client.get(path `/v2/help_center/collections/${id}`, {
|
|
110
|
+
...options,
|
|
111
|
+
headers: buildHeaders([
|
|
112
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
113
|
+
options?.headers,
|
|
114
|
+
]),
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Updates an existing collection. Only include the fields you wish to update.
|
|
119
|
+
*
|
|
120
|
+
* ### Path Parameters
|
|
121
|
+
*
|
|
122
|
+
* - `id` - The unique identifier of the collection to update
|
|
123
|
+
*
|
|
124
|
+
* ### Request Body
|
|
125
|
+
*
|
|
126
|
+
* All fields are optional. Only provided fields will be updated:
|
|
127
|
+
*
|
|
128
|
+
* - `name` - The new name of the collection
|
|
129
|
+
* - `description` - The new description of the collection
|
|
130
|
+
* - `icon` - An updated icon object for the collection (with type and value)
|
|
131
|
+
* - `parentId` - The new parent collection ID, if applicable (null for root level)
|
|
132
|
+
* - `translations` - A dictionary of updated translations keyed by locale code
|
|
133
|
+
*
|
|
134
|
+
* ### Response
|
|
135
|
+
*
|
|
136
|
+
* Returns the updated collection object with:
|
|
137
|
+
*
|
|
138
|
+
* - `id` - Unique identifier
|
|
139
|
+
* - `name` - Collection name
|
|
140
|
+
* - `description` - Collection description
|
|
141
|
+
* - `slug` - URL slug
|
|
142
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
143
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
144
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
145
|
+
* - `organization` - Organization ID
|
|
146
|
+
* - `defaultLocale` - Default locale for content
|
|
147
|
+
* - `locale` - Current locale
|
|
148
|
+
* - `availableLocales` - Array of available locales
|
|
149
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
150
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
151
|
+
* - `articleCount` - Number of articles in this collection
|
|
152
|
+
* - `authorCount` - Number of authors who contributed
|
|
153
|
+
* - `order` - Display order
|
|
154
|
+
* - `translations` - Translations for different locales
|
|
155
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
156
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
157
|
+
*
|
|
158
|
+
* ### Errors
|
|
159
|
+
*
|
|
160
|
+
* - `404` - Collection not found in your organization's help center
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* ```ts
|
|
164
|
+
* const collection =
|
|
165
|
+
* await client.helpCenter.collections.update('3416135');
|
|
166
|
+
* ```
|
|
167
|
+
*/
|
|
168
|
+
update(id, params, options) {
|
|
169
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
170
|
+
return this._client.patch(path `/v2/help_center/collections/${id}`, {
|
|
171
|
+
body,
|
|
172
|
+
...options,
|
|
173
|
+
headers: buildHeaders([
|
|
174
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
175
|
+
options?.headers,
|
|
176
|
+
]),
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Returns a paginated list of collections within your organization's help center.
|
|
181
|
+
*
|
|
182
|
+
* Collections are used to organize articles into logical groups.
|
|
183
|
+
*
|
|
184
|
+
* ### Query Parameters
|
|
185
|
+
*
|
|
186
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
187
|
+
* - `cursor` - Cursor for pagination
|
|
188
|
+
*
|
|
189
|
+
* ### Response Format
|
|
190
|
+
*
|
|
191
|
+
* Returns a list object with:
|
|
192
|
+
*
|
|
193
|
+
* - `object` - Always "list"
|
|
194
|
+
* - `data` - Array of collection objects
|
|
195
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
196
|
+
*
|
|
197
|
+
* ### Collection Object
|
|
198
|
+
*
|
|
199
|
+
* Each collection includes:
|
|
200
|
+
*
|
|
201
|
+
* - `id` - Unique identifier
|
|
202
|
+
* - `name` - Collection name
|
|
203
|
+
* - `description` - Collection description
|
|
204
|
+
* - `slug` - URL slug
|
|
205
|
+
* - `icon` - Collection icon (emoji or custom)
|
|
206
|
+
* - `parentId` - Parent collection ID (null for root collections)
|
|
207
|
+
* - `helpCenterId` - ID of the help center this collection belongs to
|
|
208
|
+
* - `organization` - Organization ID
|
|
209
|
+
* - `defaultLocale` - Default locale for content
|
|
210
|
+
* - `locale` - Current locale
|
|
211
|
+
* - `availableLocales` - Array of available locales
|
|
212
|
+
* - `featurebaseUrl` - Featurebase URL for the collection
|
|
213
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
214
|
+
* - `articleCount` - Number of articles in this collection
|
|
215
|
+
* - `authorCount` - Number of authors who contributed
|
|
216
|
+
* - `order` - Display order
|
|
217
|
+
* - `translations` - Translations for different locales
|
|
218
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
219
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
220
|
+
*
|
|
221
|
+
* @example
|
|
222
|
+
* ```ts
|
|
223
|
+
* const collections =
|
|
224
|
+
* await client.helpCenter.collections.list();
|
|
225
|
+
* ```
|
|
226
|
+
*/
|
|
227
|
+
list(params = {}, options) {
|
|
228
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
229
|
+
return this._client.get('/v2/help_center/collections', {
|
|
230
|
+
query,
|
|
231
|
+
...options,
|
|
232
|
+
headers: buildHeaders([
|
|
233
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
234
|
+
options?.headers,
|
|
235
|
+
]),
|
|
236
|
+
});
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Deletes an existing collection.
|
|
240
|
+
*
|
|
241
|
+
* ### Path Parameters
|
|
242
|
+
*
|
|
243
|
+
* - `id` - The unique identifier of the collection to delete
|
|
244
|
+
*
|
|
245
|
+
* ### Response
|
|
246
|
+
*
|
|
247
|
+
* Returns a deletion confirmation object:
|
|
248
|
+
*
|
|
249
|
+
* - `id` - The ID of the deleted collection
|
|
250
|
+
* - `object` - Always "collection"
|
|
251
|
+
* - `deleted` - Always true
|
|
252
|
+
*
|
|
253
|
+
* ### Errors
|
|
254
|
+
*
|
|
255
|
+
* - `404` - Collection not found in your organization's help center
|
|
256
|
+
*
|
|
257
|
+
* @example
|
|
258
|
+
* ```ts
|
|
259
|
+
* const collection =
|
|
260
|
+
* await client.helpCenter.collections.delete('3416135');
|
|
261
|
+
* ```
|
|
262
|
+
*/
|
|
263
|
+
delete(id, params = {}, options) {
|
|
264
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
265
|
+
return this._client.delete(path `/v2/help_center/collections/${id}`, {
|
|
266
|
+
...options,
|
|
267
|
+
headers: buildHeaders([
|
|
268
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
269
|
+
options?.headers,
|
|
270
|
+
]),
|
|
271
|
+
});
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
//# sourceMappingURL=collections.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"collections.mjs","sourceRoot":"","sources":["../../src/resources/help-center/collections.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACtD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,EAAU,EAAE,MAA8B,EAAE,OAAwB;QACzE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE;YACjE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE;YACrD,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CACJ,EAAU,EACV,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE;YAClE,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"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as ArticlesAPI from "./articles.mjs";
|
|
3
|
+
import { Article, ArticleAuthor, ArticleCreateParams, ArticleDeleteParams, ArticleDeleteResponse, ArticleIconInputNova, ArticleListParams, ArticleListResponse, ArticleRetrieveParams, ArticleTranslation, ArticleTranslationInputNova, ArticleUpdateParams, Articles } from "./articles.mjs";
|
|
4
|
+
import * as CollectionsAPI from "./collections.mjs";
|
|
5
|
+
import { Collection, CollectionCreateParams, CollectionDeleteParams, CollectionDeleteResponse, CollectionIconNova, CollectionListParams, CollectionListResponse, CollectionRetrieveParams, CollectionTranslation, CollectionTranslationInputNova, CollectionUpdateParams, Collections } from "./collections.mjs";
|
|
6
|
+
import * as HelpCentersAPI from "./help-centers.mjs";
|
|
7
|
+
import { HelpCenter as HelpCentersAPIHelpCenter, HelpCenterListParams, HelpCenterListResponse, HelpCenterNavItem, HelpCenterRetrieveParams, HelpCenterTranslation, HelpCenters } from "./help-centers.mjs";
|
|
8
|
+
import * as RedirectRulesAPI from "./redirect-rules.mjs";
|
|
9
|
+
import { RedirectRule, RedirectRuleCreateParams, RedirectRuleDeleteParams, RedirectRuleDeleteResponse, RedirectRuleListParams, RedirectRuleListResponse, RedirectRuleRetrieveByURLParams, RedirectRuleRetrieveParams, RedirectRuleUpdateParams, RedirectRules } from "./redirect-rules.mjs";
|
|
10
|
+
export declare class HelpCenter extends APIResource {
|
|
11
|
+
helpCenters: HelpCentersAPI.HelpCenters;
|
|
12
|
+
collections: CollectionsAPI.Collections;
|
|
13
|
+
articles: ArticlesAPI.Articles;
|
|
14
|
+
redirectRules: RedirectRulesAPI.RedirectRules;
|
|
15
|
+
}
|
|
16
|
+
export declare namespace HelpCenter {
|
|
17
|
+
export { HelpCenters as HelpCenters, type HelpCentersAPIHelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCenterListResponse as HelpCenterListResponse, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
18
|
+
export { Collections as Collections, type Collection as Collection, type CollectionIconNova as CollectionIconNova, type CollectionTranslation as CollectionTranslation, type CollectionTranslationInputNova as CollectionTranslationInputNova, type CollectionListResponse as CollectionListResponse, type CollectionDeleteResponse as CollectionDeleteResponse, type CollectionCreateParams as CollectionCreateParams, type CollectionRetrieveParams as CollectionRetrieveParams, type CollectionUpdateParams as CollectionUpdateParams, type CollectionListParams as CollectionListParams, type CollectionDeleteParams as CollectionDeleteParams, };
|
|
19
|
+
export { Articles as Articles, type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type ArticleListResponse as ArticleListResponse, type ArticleDeleteResponse as ArticleDeleteResponse, type ArticleCreateParams as ArticleCreateParams, type ArticleRetrieveParams as ArticleRetrieveParams, type ArticleUpdateParams as ArticleUpdateParams, type ArticleListParams as ArticleListParams, type ArticleDeleteParams as ArticleDeleteParams, };
|
|
20
|
+
export { RedirectRules as RedirectRules, type RedirectRule as RedirectRule, type RedirectRuleListResponse as RedirectRuleListResponse, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=help-center.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"help-center.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,2BAA2B,EAC3B,mBAAmB,EACnB,QAAQ,EACT;OACM,KAAK,cAAc;OACnB,EACL,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,8BAA8B,EAC9B,sBAAsB,EACtB,WAAW,EACZ;OACM,KAAK,cAAc;OACnB,EACL,UAAU,IAAI,wBAAwB,EACtC,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,WAAW,EACZ;OACM,KAAK,gBAAgB;OACrB,EACL,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,+BAA+B,EAC/B,0BAA0B,EAC1B,wBAAwB,EACxB,aAAa,EACd;AAED,qBAAa,UAAW,SAAQ,WAAW;IACzC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;CAClG;AAOD,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,wBAAwB,IAAI,UAAU,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as ArticlesAPI from "./articles.js";
|
|
3
|
+
import { Article, ArticleAuthor, ArticleCreateParams, ArticleDeleteParams, ArticleDeleteResponse, ArticleIconInputNova, ArticleListParams, ArticleListResponse, ArticleRetrieveParams, ArticleTranslation, ArticleTranslationInputNova, ArticleUpdateParams, Articles } from "./articles.js";
|
|
4
|
+
import * as CollectionsAPI from "./collections.js";
|
|
5
|
+
import { Collection, CollectionCreateParams, CollectionDeleteParams, CollectionDeleteResponse, CollectionIconNova, CollectionListParams, CollectionListResponse, CollectionRetrieveParams, CollectionTranslation, CollectionTranslationInputNova, CollectionUpdateParams, Collections } from "./collections.js";
|
|
6
|
+
import * as HelpCentersAPI from "./help-centers.js";
|
|
7
|
+
import { HelpCenter as HelpCentersAPIHelpCenter, HelpCenterListParams, HelpCenterListResponse, HelpCenterNavItem, HelpCenterRetrieveParams, HelpCenterTranslation, HelpCenters } from "./help-centers.js";
|
|
8
|
+
import * as RedirectRulesAPI from "./redirect-rules.js";
|
|
9
|
+
import { RedirectRule, RedirectRuleCreateParams, RedirectRuleDeleteParams, RedirectRuleDeleteResponse, RedirectRuleListParams, RedirectRuleListResponse, RedirectRuleRetrieveByURLParams, RedirectRuleRetrieveParams, RedirectRuleUpdateParams, RedirectRules } from "./redirect-rules.js";
|
|
10
|
+
export declare class HelpCenter extends APIResource {
|
|
11
|
+
helpCenters: HelpCentersAPI.HelpCenters;
|
|
12
|
+
collections: CollectionsAPI.Collections;
|
|
13
|
+
articles: ArticlesAPI.Articles;
|
|
14
|
+
redirectRules: RedirectRulesAPI.RedirectRules;
|
|
15
|
+
}
|
|
16
|
+
export declare namespace HelpCenter {
|
|
17
|
+
export { HelpCenters as HelpCenters, type HelpCentersAPIHelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCenterListResponse as HelpCenterListResponse, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
18
|
+
export { Collections as Collections, type Collection as Collection, type CollectionIconNova as CollectionIconNova, type CollectionTranslation as CollectionTranslation, type CollectionTranslationInputNova as CollectionTranslationInputNova, type CollectionListResponse as CollectionListResponse, type CollectionDeleteResponse as CollectionDeleteResponse, type CollectionCreateParams as CollectionCreateParams, type CollectionRetrieveParams as CollectionRetrieveParams, type CollectionUpdateParams as CollectionUpdateParams, type CollectionListParams as CollectionListParams, type CollectionDeleteParams as CollectionDeleteParams, };
|
|
19
|
+
export { Articles as Articles, type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type ArticleListResponse as ArticleListResponse, type ArticleDeleteResponse as ArticleDeleteResponse, type ArticleCreateParams as ArticleCreateParams, type ArticleRetrieveParams as ArticleRetrieveParams, type ArticleUpdateParams as ArticleUpdateParams, type ArticleListParams as ArticleListParams, type ArticleDeleteParams as ArticleDeleteParams, };
|
|
20
|
+
export { RedirectRules as RedirectRules, type RedirectRule as RedirectRule, type RedirectRuleListResponse as RedirectRuleListResponse, type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse, type RedirectRuleCreateParams as RedirectRuleCreateParams, type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams, type RedirectRuleUpdateParams as RedirectRuleUpdateParams, type RedirectRuleListParams as RedirectRuleListParams, type RedirectRuleDeleteParams as RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams, };
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=help-center.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"help-center.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,2BAA2B,EAC3B,mBAAmB,EACnB,QAAQ,EACT;OACM,KAAK,cAAc;OACnB,EACL,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,8BAA8B,EAC9B,sBAAsB,EACtB,WAAW,EACZ;OACM,KAAK,cAAc;OACnB,EACL,UAAU,IAAI,wBAAwB,EACtC,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,WAAW,EACZ;OACM,KAAK,gBAAgB;OACrB,EACL,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,+BAA+B,EAC/B,0BAA0B,EAC1B,wBAAwB,EACxB,aAAa,EACd;AAED,qBAAa,UAAW,SAAQ,WAAW;IACzC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;CAClG;AAOD,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,wBAAwB,IAAI,UAAU,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -0,0 +1,29 @@
|
|
|
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.HelpCenter = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const ArticlesAPI = tslib_1.__importStar(require("./articles.js"));
|
|
8
|
+
const articles_1 = require("./articles.js");
|
|
9
|
+
const CollectionsAPI = tslib_1.__importStar(require("./collections.js"));
|
|
10
|
+
const collections_1 = require("./collections.js");
|
|
11
|
+
const HelpCentersAPI = tslib_1.__importStar(require("./help-centers.js"));
|
|
12
|
+
const help_centers_1 = require("./help-centers.js");
|
|
13
|
+
const RedirectRulesAPI = tslib_1.__importStar(require("./redirect-rules.js"));
|
|
14
|
+
const redirect_rules_1 = require("./redirect-rules.js");
|
|
15
|
+
class HelpCenter extends resource_1.APIResource {
|
|
16
|
+
constructor() {
|
|
17
|
+
super(...arguments);
|
|
18
|
+
this.helpCenters = new HelpCentersAPI.HelpCenters(this._client);
|
|
19
|
+
this.collections = new CollectionsAPI.Collections(this._client);
|
|
20
|
+
this.articles = new ArticlesAPI.Articles(this._client);
|
|
21
|
+
this.redirectRules = new RedirectRulesAPI.RedirectRules(this._client);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
exports.HelpCenter = HelpCenter;
|
|
25
|
+
HelpCenter.HelpCenters = help_centers_1.HelpCenters;
|
|
26
|
+
HelpCenter.Collections = collections_1.Collections;
|
|
27
|
+
HelpCenter.Articles = articles_1.Articles;
|
|
28
|
+
HelpCenter.RedirectRules = redirect_rules_1.RedirectRules;
|
|
29
|
+
//# sourceMappingURL=help-center.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"help-center.js","sourceRoot":"","sources":["../../src/resources/help-center/help-center.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CAcoB;AACpB,yEAAgD;AAChD,kDAauB;AACvB,0EAAiD;AACjD,oDAQwB;AACxB,8EAAqD;AACrD,wDAW0B;AAE1B,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnG,CAAC;CAAA;AALD,gCAKC;AAED,UAAU,CAAC,WAAW,GAAG,0BAAW,CAAC;AACrC,UAAU,CAAC,WAAW,GAAG,yBAAW,CAAC;AACrC,UAAU,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC/B,UAAU,CAAC,aAAa,GAAG,8BAAa,CAAC"}
|