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,236 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
import * as ContactsAPI_ from "../contacts/contacts.js";
|
|
5
|
+
/**
|
|
6
|
+
* Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
|
|
7
|
+
*/
|
|
8
|
+
export declare class Contacts extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Returns all contacts (customers) attached to a specific company.
|
|
11
|
+
*
|
|
12
|
+
* Only returns contacts with type "customer" that have the company in their
|
|
13
|
+
* `companyIds` array. Uses cursor-based pagination.
|
|
14
|
+
*
|
|
15
|
+
* ### Path Parameters
|
|
16
|
+
*
|
|
17
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
18
|
+
*
|
|
19
|
+
* ### Query Parameters
|
|
20
|
+
*
|
|
21
|
+
* - `limit` - Number of contacts to return (1-100, default: 10)
|
|
22
|
+
* - `cursor` - Opaque cursor from a previous response for pagination
|
|
23
|
+
*
|
|
24
|
+
* ### Response Structure
|
|
25
|
+
*
|
|
26
|
+
* The response includes:
|
|
27
|
+
*
|
|
28
|
+
* - `object` - Always "list"
|
|
29
|
+
* - `data` - Array of contact objects
|
|
30
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
31
|
+
*
|
|
32
|
+
* ### Example Response
|
|
33
|
+
*
|
|
34
|
+
* ```json
|
|
35
|
+
* {
|
|
36
|
+
* "object": "list",
|
|
37
|
+
* "data": [
|
|
38
|
+
* {
|
|
39
|
+
* "object": "contact",
|
|
40
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
41
|
+
* "userId": "usr_12345",
|
|
42
|
+
* "email": "john@acme.com",
|
|
43
|
+
* "name": "John Doe",
|
|
44
|
+
* "type": "customer",
|
|
45
|
+
* "companies": [...],
|
|
46
|
+
* "createdAt": "2025-01-01T12:00:00.000Z"
|
|
47
|
+
* }
|
|
48
|
+
* ],
|
|
49
|
+
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
50
|
+
* }
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* ### Error Responses
|
|
54
|
+
*
|
|
55
|
+
* - **404 Not Found** - Company with the specified ID does not exist
|
|
56
|
+
*
|
|
57
|
+
* ### Version Availability
|
|
58
|
+
*
|
|
59
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const contactList = await client.companies.contacts.list(
|
|
64
|
+
* '507f1f77bcf86cd799439011',
|
|
65
|
+
* );
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
list(id: string, params?: ContactListParams | null | undefined, options?: RequestOptions): APIPromise<ContactsAPI_.ContactList>;
|
|
69
|
+
/**
|
|
70
|
+
* Attaches a contact (customer) to a company.
|
|
71
|
+
*
|
|
72
|
+
* Adds the company to the contact's `companyIds` array and embedded `companies`
|
|
73
|
+
* array. This operation is **additive** - existing company associations are
|
|
74
|
+
* preserved. Also increments the `linkedUsers` count on the company.
|
|
75
|
+
*
|
|
76
|
+
* ### Path Parameters
|
|
77
|
+
*
|
|
78
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
79
|
+
*
|
|
80
|
+
* ### Request Body
|
|
81
|
+
*
|
|
82
|
+
* | Field | Type | Required | Description |
|
|
83
|
+
* | ----------- | ------ | -------- | ----------------------------------------------------------------------- |
|
|
84
|
+
* | `contactId` | string | Yes | The Featurebase internal ID of the contact to attach (MongoDB ObjectId) |
|
|
85
|
+
*
|
|
86
|
+
* ### Example Request
|
|
87
|
+
*
|
|
88
|
+
* ```json
|
|
89
|
+
* {
|
|
90
|
+
* "contactId": "507f1f77bcf86cd799439012"
|
|
91
|
+
* }
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* ### Response
|
|
95
|
+
*
|
|
96
|
+
* Returns the updated contact object with the new company association.
|
|
97
|
+
*
|
|
98
|
+
* ### Example Response
|
|
99
|
+
*
|
|
100
|
+
* ```json
|
|
101
|
+
* {
|
|
102
|
+
* "object": "contact",
|
|
103
|
+
* "id": "507f1f77bcf86cd799439012",
|
|
104
|
+
* "userId": "usr_12345",
|
|
105
|
+
* "email": "john@acme.com",
|
|
106
|
+
* "name": "John Doe",
|
|
107
|
+
* "type": "customer",
|
|
108
|
+
* "companies": [
|
|
109
|
+
* {
|
|
110
|
+
* "object": "company",
|
|
111
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
112
|
+
* "companyId": "comp_12345",
|
|
113
|
+
* "name": "Acme Inc"
|
|
114
|
+
* }
|
|
115
|
+
* ]
|
|
116
|
+
* }
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
119
|
+
* ### Error Responses
|
|
120
|
+
*
|
|
121
|
+
* - **404 Not Found** - Company or contact does not exist
|
|
122
|
+
*
|
|
123
|
+
* ### Version Availability
|
|
124
|
+
*
|
|
125
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```ts
|
|
129
|
+
* const response = await client.companies.contacts.attach(
|
|
130
|
+
* '507f1f77bcf86cd799439011',
|
|
131
|
+
* { contactId: '507f1f77bcf86cd799439012' },
|
|
132
|
+
* );
|
|
133
|
+
* ```
|
|
134
|
+
*/
|
|
135
|
+
attach(id: string, params: ContactAttachParams, options?: RequestOptions): APIPromise<ContactAttachResponse>;
|
|
136
|
+
/**
|
|
137
|
+
* Removes a contact (customer) from a company.
|
|
138
|
+
*
|
|
139
|
+
* Removes the company from the contact's `companyIds` array and embedded
|
|
140
|
+
* `companies` array. Also decrements the `linkedUsers` count on the company.
|
|
141
|
+
*
|
|
142
|
+
* ### Path Parameters
|
|
143
|
+
*
|
|
144
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
145
|
+
* - `contactId` - The Featurebase internal ID of the contact to remove (MongoDB
|
|
146
|
+
* ObjectId)
|
|
147
|
+
*
|
|
148
|
+
* ### Response
|
|
149
|
+
*
|
|
150
|
+
* Returns the updated contact object with the company removed.
|
|
151
|
+
*
|
|
152
|
+
* ### Example Response
|
|
153
|
+
*
|
|
154
|
+
* ```json
|
|
155
|
+
* {
|
|
156
|
+
* "object": "contact",
|
|
157
|
+
* "id": "507f1f77bcf86cd799439012",
|
|
158
|
+
* "userId": "usr_12345",
|
|
159
|
+
* "email": "john@acme.com",
|
|
160
|
+
* "name": "John Doe",
|
|
161
|
+
* "type": "customer",
|
|
162
|
+
* "companies": []
|
|
163
|
+
* }
|
|
164
|
+
* ```
|
|
165
|
+
*
|
|
166
|
+
* ### Error Responses
|
|
167
|
+
*
|
|
168
|
+
* - **400 Bad Request** - Contact is not attached to this company
|
|
169
|
+
* - **404 Not Found** - Company or contact does not exist
|
|
170
|
+
*
|
|
171
|
+
* ### Version Availability
|
|
172
|
+
*
|
|
173
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* ```ts
|
|
177
|
+
* const contact = await client.companies.contacts.remove(
|
|
178
|
+
* '507f1f77bcf86cd799439012',
|
|
179
|
+
* { id: '507f1f77bcf86cd799439011' },
|
|
180
|
+
* );
|
|
181
|
+
* ```
|
|
182
|
+
*/
|
|
183
|
+
remove(contactID: string, params: ContactRemoveParams, options?: RequestOptions): APIPromise<ContactRemoveResponse>;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* User who submitted the response
|
|
187
|
+
*/
|
|
188
|
+
export type ContactAttachResponse = ContactsAPI_.Contact | (null & {});
|
|
189
|
+
/**
|
|
190
|
+
* User who submitted the response
|
|
191
|
+
*/
|
|
192
|
+
export type ContactRemoveResponse = ContactsAPI_.Contact | (null & {});
|
|
193
|
+
export interface ContactListParams {
|
|
194
|
+
/**
|
|
195
|
+
* Query param: An opaque cursor for pagination. Use the nextCursor value from a
|
|
196
|
+
* previous response to fetch the next page of results.
|
|
197
|
+
*/
|
|
198
|
+
cursor?: string;
|
|
199
|
+
/**
|
|
200
|
+
* Query param: A limit on the number of contacts to be returned, between 1
|
|
201
|
+
* and 100.
|
|
202
|
+
*/
|
|
203
|
+
limit?: number;
|
|
204
|
+
/**
|
|
205
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
206
|
+
* configured API version if not specified.
|
|
207
|
+
*/
|
|
208
|
+
'Featurebase-Version'?: string;
|
|
209
|
+
}
|
|
210
|
+
export interface ContactAttachParams {
|
|
211
|
+
/**
|
|
212
|
+
* Body param: The Featurebase internal ID of the contact to attach (MongoDB
|
|
213
|
+
* ObjectId)
|
|
214
|
+
*/
|
|
215
|
+
contactId: string;
|
|
216
|
+
/**
|
|
217
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
218
|
+
* configured API version if not specified.
|
|
219
|
+
*/
|
|
220
|
+
'Featurebase-Version'?: string;
|
|
221
|
+
}
|
|
222
|
+
export interface ContactRemoveParams {
|
|
223
|
+
/**
|
|
224
|
+
* Path param: The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
225
|
+
*/
|
|
226
|
+
id: string;
|
|
227
|
+
/**
|
|
228
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
229
|
+
* configured API version if not specified.
|
|
230
|
+
*/
|
|
231
|
+
'Featurebase-Version'?: string;
|
|
232
|
+
}
|
|
233
|
+
export declare namespace Contacts {
|
|
234
|
+
export { type ContactAttachResponse as ContactAttachResponse, type ContactRemoveResponse as ContactRemoveResponse, type ContactListParams as ContactListParams, type ContactAttachParams as ContactAttachParams, type ContactRemoveParams as ContactRemoveParams, };
|
|
235
|
+
}
|
|
236
|
+
//# sourceMappingURL=contacts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../../src/resources/companies/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;OAElB,KAAK,YAAY;AAExB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC;IAYvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAYpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAUrC;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AAEvE,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,218 @@
|
|
|
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.Contacts = 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
|
+
* Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
|
|
10
|
+
*/
|
|
11
|
+
class Contacts extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* Returns all contacts (customers) attached to a specific company.
|
|
14
|
+
*
|
|
15
|
+
* Only returns contacts with type "customer" that have the company in their
|
|
16
|
+
* `companyIds` array. Uses cursor-based pagination.
|
|
17
|
+
*
|
|
18
|
+
* ### Path Parameters
|
|
19
|
+
*
|
|
20
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
21
|
+
*
|
|
22
|
+
* ### Query Parameters
|
|
23
|
+
*
|
|
24
|
+
* - `limit` - Number of contacts to return (1-100, default: 10)
|
|
25
|
+
* - `cursor` - Opaque cursor from a previous response for pagination
|
|
26
|
+
*
|
|
27
|
+
* ### Response Structure
|
|
28
|
+
*
|
|
29
|
+
* The response includes:
|
|
30
|
+
*
|
|
31
|
+
* - `object` - Always "list"
|
|
32
|
+
* - `data` - Array of contact objects
|
|
33
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
34
|
+
*
|
|
35
|
+
* ### Example Response
|
|
36
|
+
*
|
|
37
|
+
* ```json
|
|
38
|
+
* {
|
|
39
|
+
* "object": "list",
|
|
40
|
+
* "data": [
|
|
41
|
+
* {
|
|
42
|
+
* "object": "contact",
|
|
43
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
44
|
+
* "userId": "usr_12345",
|
|
45
|
+
* "email": "john@acme.com",
|
|
46
|
+
* "name": "John Doe",
|
|
47
|
+
* "type": "customer",
|
|
48
|
+
* "companies": [...],
|
|
49
|
+
* "createdAt": "2025-01-01T12:00:00.000Z"
|
|
50
|
+
* }
|
|
51
|
+
* ],
|
|
52
|
+
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
53
|
+
* }
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* ### Error Responses
|
|
57
|
+
*
|
|
58
|
+
* - **404 Not Found** - Company with the specified ID does not exist
|
|
59
|
+
*
|
|
60
|
+
* ### Version Availability
|
|
61
|
+
*
|
|
62
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const contactList = await client.companies.contacts.list(
|
|
67
|
+
* '507f1f77bcf86cd799439011',
|
|
68
|
+
* );
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
list(id, params = {}, options) {
|
|
72
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
73
|
+
return this._client.get((0, path_1.path) `/v2/companies/${id}/contacts`, {
|
|
74
|
+
query,
|
|
75
|
+
...options,
|
|
76
|
+
headers: (0, headers_1.buildHeaders)([
|
|
77
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
78
|
+
options?.headers,
|
|
79
|
+
]),
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Attaches a contact (customer) to a company.
|
|
84
|
+
*
|
|
85
|
+
* Adds the company to the contact's `companyIds` array and embedded `companies`
|
|
86
|
+
* array. This operation is **additive** - existing company associations are
|
|
87
|
+
* preserved. Also increments the `linkedUsers` count on the company.
|
|
88
|
+
*
|
|
89
|
+
* ### Path Parameters
|
|
90
|
+
*
|
|
91
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
92
|
+
*
|
|
93
|
+
* ### Request Body
|
|
94
|
+
*
|
|
95
|
+
* | Field | Type | Required | Description |
|
|
96
|
+
* | ----------- | ------ | -------- | ----------------------------------------------------------------------- |
|
|
97
|
+
* | `contactId` | string | Yes | The Featurebase internal ID of the contact to attach (MongoDB ObjectId) |
|
|
98
|
+
*
|
|
99
|
+
* ### Example Request
|
|
100
|
+
*
|
|
101
|
+
* ```json
|
|
102
|
+
* {
|
|
103
|
+
* "contactId": "507f1f77bcf86cd799439012"
|
|
104
|
+
* }
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* ### Response
|
|
108
|
+
*
|
|
109
|
+
* Returns the updated contact object with the new company association.
|
|
110
|
+
*
|
|
111
|
+
* ### Example Response
|
|
112
|
+
*
|
|
113
|
+
* ```json
|
|
114
|
+
* {
|
|
115
|
+
* "object": "contact",
|
|
116
|
+
* "id": "507f1f77bcf86cd799439012",
|
|
117
|
+
* "userId": "usr_12345",
|
|
118
|
+
* "email": "john@acme.com",
|
|
119
|
+
* "name": "John Doe",
|
|
120
|
+
* "type": "customer",
|
|
121
|
+
* "companies": [
|
|
122
|
+
* {
|
|
123
|
+
* "object": "company",
|
|
124
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
125
|
+
* "companyId": "comp_12345",
|
|
126
|
+
* "name": "Acme Inc"
|
|
127
|
+
* }
|
|
128
|
+
* ]
|
|
129
|
+
* }
|
|
130
|
+
* ```
|
|
131
|
+
*
|
|
132
|
+
* ### Error Responses
|
|
133
|
+
*
|
|
134
|
+
* - **404 Not Found** - Company or contact does not exist
|
|
135
|
+
*
|
|
136
|
+
* ### Version Availability
|
|
137
|
+
*
|
|
138
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```ts
|
|
142
|
+
* const response = await client.companies.contacts.attach(
|
|
143
|
+
* '507f1f77bcf86cd799439011',
|
|
144
|
+
* { contactId: '507f1f77bcf86cd799439012' },
|
|
145
|
+
* );
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
attach(id, params, options) {
|
|
149
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
150
|
+
return this._client.post((0, path_1.path) `/v2/companies/${id}/contacts`, {
|
|
151
|
+
body,
|
|
152
|
+
...options,
|
|
153
|
+
headers: (0, headers_1.buildHeaders)([
|
|
154
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
155
|
+
options?.headers,
|
|
156
|
+
]),
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Removes a contact (customer) from a company.
|
|
161
|
+
*
|
|
162
|
+
* Removes the company from the contact's `companyIds` array and embedded
|
|
163
|
+
* `companies` array. Also decrements the `linkedUsers` count on the company.
|
|
164
|
+
*
|
|
165
|
+
* ### Path Parameters
|
|
166
|
+
*
|
|
167
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
168
|
+
* - `contactId` - The Featurebase internal ID of the contact to remove (MongoDB
|
|
169
|
+
* ObjectId)
|
|
170
|
+
*
|
|
171
|
+
* ### Response
|
|
172
|
+
*
|
|
173
|
+
* Returns the updated contact object with the company removed.
|
|
174
|
+
*
|
|
175
|
+
* ### Example Response
|
|
176
|
+
*
|
|
177
|
+
* ```json
|
|
178
|
+
* {
|
|
179
|
+
* "object": "contact",
|
|
180
|
+
* "id": "507f1f77bcf86cd799439012",
|
|
181
|
+
* "userId": "usr_12345",
|
|
182
|
+
* "email": "john@acme.com",
|
|
183
|
+
* "name": "John Doe",
|
|
184
|
+
* "type": "customer",
|
|
185
|
+
* "companies": []
|
|
186
|
+
* }
|
|
187
|
+
* ```
|
|
188
|
+
*
|
|
189
|
+
* ### Error Responses
|
|
190
|
+
*
|
|
191
|
+
* - **400 Bad Request** - Contact is not attached to this company
|
|
192
|
+
* - **404 Not Found** - Company or contact does not exist
|
|
193
|
+
*
|
|
194
|
+
* ### Version Availability
|
|
195
|
+
*
|
|
196
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
197
|
+
*
|
|
198
|
+
* @example
|
|
199
|
+
* ```ts
|
|
200
|
+
* const contact = await client.companies.contacts.remove(
|
|
201
|
+
* '507f1f77bcf86cd799439012',
|
|
202
|
+
* { id: '507f1f77bcf86cd799439011' },
|
|
203
|
+
* );
|
|
204
|
+
* ```
|
|
205
|
+
*/
|
|
206
|
+
remove(contactID, params, options) {
|
|
207
|
+
const { id, 'Featurebase-Version': featurebaseVersion } = params;
|
|
208
|
+
return this._client.delete((0, path_1.path) `/v2/companies/${id}/contacts/${contactID}`, {
|
|
209
|
+
...options,
|
|
210
|
+
headers: (0, headers_1.buildHeaders)([
|
|
211
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
212
|
+
options?.headers,
|
|
213
|
+
]),
|
|
214
|
+
});
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
exports.Contacts = Contacts;
|
|
218
|
+
//# sourceMappingURL=contacts.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../src/resources/companies/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAGjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,EAAU,EACV,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,IAAA,WAAI,EAAA,iBAAiB,EAAE,WAAW,EAAE;YAC1D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,WAAW,EAAE;YAC3D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,SAAiB,EACjB,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,aAAa,SAAS,EAAE,EAAE;YAC1E,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;AA3ND,4BA2NC"}
|
|
@@ -0,0 +1,214 @@
|
|
|
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
|
+
* Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
|
|
7
|
+
*/
|
|
8
|
+
export class Contacts extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Returns all contacts (customers) attached to a specific company.
|
|
11
|
+
*
|
|
12
|
+
* Only returns contacts with type "customer" that have the company in their
|
|
13
|
+
* `companyIds` array. Uses cursor-based pagination.
|
|
14
|
+
*
|
|
15
|
+
* ### Path Parameters
|
|
16
|
+
*
|
|
17
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
18
|
+
*
|
|
19
|
+
* ### Query Parameters
|
|
20
|
+
*
|
|
21
|
+
* - `limit` - Number of contacts to return (1-100, default: 10)
|
|
22
|
+
* - `cursor` - Opaque cursor from a previous response for pagination
|
|
23
|
+
*
|
|
24
|
+
* ### Response Structure
|
|
25
|
+
*
|
|
26
|
+
* The response includes:
|
|
27
|
+
*
|
|
28
|
+
* - `object` - Always "list"
|
|
29
|
+
* - `data` - Array of contact objects
|
|
30
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
31
|
+
*
|
|
32
|
+
* ### Example Response
|
|
33
|
+
*
|
|
34
|
+
* ```json
|
|
35
|
+
* {
|
|
36
|
+
* "object": "list",
|
|
37
|
+
* "data": [
|
|
38
|
+
* {
|
|
39
|
+
* "object": "contact",
|
|
40
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
41
|
+
* "userId": "usr_12345",
|
|
42
|
+
* "email": "john@acme.com",
|
|
43
|
+
* "name": "John Doe",
|
|
44
|
+
* "type": "customer",
|
|
45
|
+
* "companies": [...],
|
|
46
|
+
* "createdAt": "2025-01-01T12:00:00.000Z"
|
|
47
|
+
* }
|
|
48
|
+
* ],
|
|
49
|
+
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
50
|
+
* }
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* ### Error Responses
|
|
54
|
+
*
|
|
55
|
+
* - **404 Not Found** - Company with the specified ID does not exist
|
|
56
|
+
*
|
|
57
|
+
* ### Version Availability
|
|
58
|
+
*
|
|
59
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const contactList = await client.companies.contacts.list(
|
|
64
|
+
* '507f1f77bcf86cd799439011',
|
|
65
|
+
* );
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
list(id, params = {}, options) {
|
|
69
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
70
|
+
return this._client.get(path `/v2/companies/${id}/contacts`, {
|
|
71
|
+
query,
|
|
72
|
+
...options,
|
|
73
|
+
headers: buildHeaders([
|
|
74
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
75
|
+
options?.headers,
|
|
76
|
+
]),
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Attaches a contact (customer) to a company.
|
|
81
|
+
*
|
|
82
|
+
* Adds the company to the contact's `companyIds` array and embedded `companies`
|
|
83
|
+
* array. This operation is **additive** - existing company associations are
|
|
84
|
+
* preserved. Also increments the `linkedUsers` count on the company.
|
|
85
|
+
*
|
|
86
|
+
* ### Path Parameters
|
|
87
|
+
*
|
|
88
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
89
|
+
*
|
|
90
|
+
* ### Request Body
|
|
91
|
+
*
|
|
92
|
+
* | Field | Type | Required | Description |
|
|
93
|
+
* | ----------- | ------ | -------- | ----------------------------------------------------------------------- |
|
|
94
|
+
* | `contactId` | string | Yes | The Featurebase internal ID of the contact to attach (MongoDB ObjectId) |
|
|
95
|
+
*
|
|
96
|
+
* ### Example Request
|
|
97
|
+
*
|
|
98
|
+
* ```json
|
|
99
|
+
* {
|
|
100
|
+
* "contactId": "507f1f77bcf86cd799439012"
|
|
101
|
+
* }
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
104
|
+
* ### Response
|
|
105
|
+
*
|
|
106
|
+
* Returns the updated contact object with the new company association.
|
|
107
|
+
*
|
|
108
|
+
* ### Example Response
|
|
109
|
+
*
|
|
110
|
+
* ```json
|
|
111
|
+
* {
|
|
112
|
+
* "object": "contact",
|
|
113
|
+
* "id": "507f1f77bcf86cd799439012",
|
|
114
|
+
* "userId": "usr_12345",
|
|
115
|
+
* "email": "john@acme.com",
|
|
116
|
+
* "name": "John Doe",
|
|
117
|
+
* "type": "customer",
|
|
118
|
+
* "companies": [
|
|
119
|
+
* {
|
|
120
|
+
* "object": "company",
|
|
121
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
122
|
+
* "companyId": "comp_12345",
|
|
123
|
+
* "name": "Acme Inc"
|
|
124
|
+
* }
|
|
125
|
+
* ]
|
|
126
|
+
* }
|
|
127
|
+
* ```
|
|
128
|
+
*
|
|
129
|
+
* ### Error Responses
|
|
130
|
+
*
|
|
131
|
+
* - **404 Not Found** - Company or contact does not exist
|
|
132
|
+
*
|
|
133
|
+
* ### Version Availability
|
|
134
|
+
*
|
|
135
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
136
|
+
*
|
|
137
|
+
* @example
|
|
138
|
+
* ```ts
|
|
139
|
+
* const response = await client.companies.contacts.attach(
|
|
140
|
+
* '507f1f77bcf86cd799439011',
|
|
141
|
+
* { contactId: '507f1f77bcf86cd799439012' },
|
|
142
|
+
* );
|
|
143
|
+
* ```
|
|
144
|
+
*/
|
|
145
|
+
attach(id, params, options) {
|
|
146
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
147
|
+
return this._client.post(path `/v2/companies/${id}/contacts`, {
|
|
148
|
+
body,
|
|
149
|
+
...options,
|
|
150
|
+
headers: buildHeaders([
|
|
151
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
152
|
+
options?.headers,
|
|
153
|
+
]),
|
|
154
|
+
});
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Removes a contact (customer) from a company.
|
|
158
|
+
*
|
|
159
|
+
* Removes the company from the contact's `companyIds` array and embedded
|
|
160
|
+
* `companies` array. Also decrements the `linkedUsers` count on the company.
|
|
161
|
+
*
|
|
162
|
+
* ### Path Parameters
|
|
163
|
+
*
|
|
164
|
+
* - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
|
|
165
|
+
* - `contactId` - The Featurebase internal ID of the contact to remove (MongoDB
|
|
166
|
+
* ObjectId)
|
|
167
|
+
*
|
|
168
|
+
* ### Response
|
|
169
|
+
*
|
|
170
|
+
* Returns the updated contact object with the company removed.
|
|
171
|
+
*
|
|
172
|
+
* ### Example Response
|
|
173
|
+
*
|
|
174
|
+
* ```json
|
|
175
|
+
* {
|
|
176
|
+
* "object": "contact",
|
|
177
|
+
* "id": "507f1f77bcf86cd799439012",
|
|
178
|
+
* "userId": "usr_12345",
|
|
179
|
+
* "email": "john@acme.com",
|
|
180
|
+
* "name": "John Doe",
|
|
181
|
+
* "type": "customer",
|
|
182
|
+
* "companies": []
|
|
183
|
+
* }
|
|
184
|
+
* ```
|
|
185
|
+
*
|
|
186
|
+
* ### Error Responses
|
|
187
|
+
*
|
|
188
|
+
* - **400 Bad Request** - Contact is not attached to this company
|
|
189
|
+
* - **404 Not Found** - Company or contact does not exist
|
|
190
|
+
*
|
|
191
|
+
* ### Version Availability
|
|
192
|
+
*
|
|
193
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* ```ts
|
|
197
|
+
* const contact = await client.companies.contacts.remove(
|
|
198
|
+
* '507f1f77bcf86cd799439012',
|
|
199
|
+
* { id: '507f1f77bcf86cd799439011' },
|
|
200
|
+
* );
|
|
201
|
+
* ```
|
|
202
|
+
*/
|
|
203
|
+
remove(contactID, params, options) {
|
|
204
|
+
const { id, 'Featurebase-Version': featurebaseVersion } = params;
|
|
205
|
+
return this._client.delete(path `/v2/companies/${id}/contacts/${contactID}`, {
|
|
206
|
+
...options,
|
|
207
|
+
headers: buildHeaders([
|
|
208
|
+
{ ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
|
|
209
|
+
options?.headers,
|
|
210
|
+
]),
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
//# sourceMappingURL=contacts.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../../src/resources/companies/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAGf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,EAAU,EACV,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,IAAI,CAAA,iBAAiB,EAAE,WAAW,EAAE;YAC1D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,EAAE,WAAW,EAAE;YAC3D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,SAAiB,EACjB,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,EAAE,aAAa,SAAS,EAAE,EAAE;YAC1E,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,3 @@
|
|
|
1
|
+
export { Companies, type Company, type DeletedCompany, type CompanyListResponse, type CompanyRetrieveParams, type CompanyListParams, type CompanyDeleteParams, type CompanyCreateOrUpdateParams, type CompanyDeleteByCompanyIDParams, } from "./companies.mjs";
|
|
2
|
+
export { Contacts, type ContactAttachResponse, type ContactRemoveResponse, type ContactListParams, type ContactAttachParams, type ContactRemoveParams, } from "./contacts.mjs";
|
|
3
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/companies/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC;OACM,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB"}
|