@knocklabs/node 0.6.19 → 1.1.0
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 +48 -7
- package/LICENSE +201 -21
- package/README.md +338 -129
- 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 +223 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +223 -0
- package/client.d.ts.map +1 -0
- package/client.js +485 -0
- package/client.js.map +1 -0
- package/client.mjs +481 -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/pagination.d.mts +111 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +111 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +173 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +164 -0
- package/core/pagination.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 +7 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +7 -0
- package/index.d.ts.map +1 -0
- package/index.js +32 -0
- package/index.js.map +1 -0
- package/index.mjs +8 -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 +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +6 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +6 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +11 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +8 -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 +279 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +276 -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/{dist/src/common/interfaces.js → internal/qs/types.js} +1 -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 +14 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +14 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +229 -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 +32 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +32 -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 +28 -0
- package/internal/shim-types.d.ts +28 -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 +67 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +67 -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 +58 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +53 -0
- package/internal/utils/path.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 +16 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +16 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +109 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +92 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/lib/index.d.mts +6 -0
- package/lib/index.d.mts.map +1 -0
- package/lib/index.d.ts +6 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +9 -0
- package/lib/index.js.map +1 -0
- package/lib/index.mjs +6 -0
- package/lib/index.mjs.map +1 -0
- package/lib/tokenSigner.d.mts +46 -0
- package/lib/tokenSigner.d.mts.map +1 -0
- package/lib/tokenSigner.d.ts +46 -0
- package/lib/tokenSigner.d.ts.map +1 -0
- package/lib/tokenSigner.js +131 -0
- package/lib/tokenSigner.js.map +1 -0
- package/lib/tokenSigner.mjs +125 -0
- package/lib/tokenSigner.mjs.map +1 -0
- package/lib/userTokens.d.mts +32 -0
- package/lib/userTokens.d.mts.map +1 -0
- package/{dist/src/common → lib}/userTokens.d.ts +7 -3
- package/lib/userTokens.d.ts.map +1 -0
- package/{dist/src/common → lib}/userTokens.js +4 -0
- package/lib/userTokens.js.map +1 -0
- package/lib/userTokens.mjs +12 -0
- package/lib/userTokens.mjs.map +1 -0
- package/package.json +155 -38
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -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/audiences.d.mts +160 -0
- package/resources/audiences.d.mts.map +1 -0
- package/resources/audiences.d.ts +160 -0
- package/resources/audiences.d.ts.map +1 -0
- package/resources/audiences.js +53 -0
- package/resources/audiences.js.map +1 -0
- package/resources/audiences.mjs +49 -0
- package/resources/audiences.mjs.map +1 -0
- package/resources/bulk-operations.d.mts +97 -0
- package/resources/bulk-operations.d.mts.map +1 -0
- package/resources/bulk-operations.d.ts +97 -0
- package/resources/bulk-operations.d.ts.map +1 -0
- package/resources/bulk-operations.js +23 -0
- package/resources/bulk-operations.js.map +1 -0
- package/resources/bulk-operations.mjs +19 -0
- package/resources/bulk-operations.mjs.map +1 -0
- package/resources/channels/bulk.d.mts +82 -0
- package/resources/channels/bulk.d.mts.map +1 -0
- package/resources/channels/bulk.d.ts +82 -0
- package/resources/channels/bulk.d.ts.map +1 -0
- package/resources/channels/bulk.js +40 -0
- package/resources/channels/bulk.js.map +1 -0
- package/resources/channels/bulk.mjs +36 -0
- package/resources/channels/bulk.mjs.map +1 -0
- package/resources/channels/channels.d.mts +10 -0
- package/resources/channels/channels.d.mts.map +1 -0
- package/resources/channels/channels.d.ts +10 -0
- package/resources/channels/channels.d.ts.map +1 -0
- package/resources/channels/channels.js +17 -0
- package/resources/channels/channels.js.map +1 -0
- package/resources/channels/channels.mjs +12 -0
- package/resources/channels/channels.mjs.map +1 -0
- package/resources/channels/index.d.mts +3 -0
- package/resources/channels/index.d.mts.map +1 -0
- package/resources/channels/index.d.ts +3 -0
- package/resources/channels/index.d.ts.map +1 -0
- package/resources/channels/index.js +9 -0
- package/resources/channels/index.js.map +1 -0
- package/resources/channels/index.mjs +4 -0
- package/resources/channels/index.mjs.map +1 -0
- package/resources/channels.d.mts +2 -0
- package/resources/channels.d.mts.map +1 -0
- package/resources/channels.d.ts +2 -0
- package/resources/channels.d.ts.map +1 -0
- package/resources/channels.js +6 -0
- package/resources/channels.js.map +1 -0
- package/resources/channels.mjs +3 -0
- package/resources/channels.mjs.map +1 -0
- package/resources/index.d.mts +14 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +14 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +31 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +15 -0
- package/resources/index.mjs.map +1 -0
- package/resources/integrations/census.d.mts +41 -0
- package/resources/integrations/census.d.mts.map +1 -0
- package/resources/integrations/census.d.ts +41 -0
- package/resources/integrations/census.d.ts.map +1 -0
- package/resources/integrations/census.js +15 -0
- package/resources/integrations/census.js.map +1 -0
- package/resources/integrations/census.mjs +11 -0
- package/resources/integrations/census.mjs.map +1 -0
- package/resources/integrations/hightouch.d.mts +41 -0
- package/resources/integrations/hightouch.d.mts.map +1 -0
- package/resources/integrations/hightouch.d.ts +41 -0
- package/resources/integrations/hightouch.d.ts.map +1 -0
- package/resources/integrations/hightouch.js +15 -0
- package/resources/integrations/hightouch.js.map +1 -0
- package/resources/integrations/hightouch.mjs +11 -0
- package/resources/integrations/hightouch.mjs.map +1 -0
- package/resources/integrations/index.d.mts +4 -0
- package/resources/integrations/index.d.mts.map +1 -0
- package/resources/integrations/index.d.ts +4 -0
- package/resources/integrations/index.d.ts.map +1 -0
- package/resources/integrations/index.js +11 -0
- package/resources/integrations/index.js.map +1 -0
- package/resources/integrations/index.mjs +5 -0
- package/resources/integrations/index.mjs.map +1 -0
- package/resources/integrations/integrations.d.mts +14 -0
- package/resources/integrations/integrations.d.mts.map +1 -0
- package/resources/integrations/integrations.d.ts +14 -0
- package/resources/integrations/integrations.d.ts.map +1 -0
- package/resources/integrations/integrations.js +21 -0
- package/resources/integrations/integrations.js.map +1 -0
- package/resources/integrations/integrations.mjs +16 -0
- package/resources/integrations/integrations.mjs.map +1 -0
- package/resources/integrations.d.mts +2 -0
- package/resources/integrations.d.mts.map +1 -0
- package/resources/integrations.d.ts +2 -0
- package/resources/integrations.d.ts.map +1 -0
- package/resources/integrations.js +6 -0
- package/resources/integrations.js.map +1 -0
- package/resources/integrations.mjs +3 -0
- package/resources/integrations.mjs.map +1 -0
- package/resources/messages/activities.d.mts +32 -0
- package/resources/messages/activities.d.mts.map +1 -0
- package/resources/messages/activities.d.ts +32 -0
- package/resources/messages/activities.d.ts.map +1 -0
- package/resources/messages/activities.js +27 -0
- package/resources/messages/activities.js.map +1 -0
- package/resources/messages/activities.mjs +23 -0
- package/resources/messages/activities.mjs.map +1 -0
- package/resources/messages/batch.d.mts +455 -0
- package/resources/messages/batch.d.mts.map +1 -0
- package/resources/messages/batch.d.ts +455 -0
- package/resources/messages/batch.d.ts.map +1 -0
- package/resources/messages/batch.js +147 -0
- package/resources/messages/batch.js.map +1 -0
- package/resources/messages/batch.mjs +143 -0
- package/resources/messages/batch.mjs.map +1 -0
- package/resources/messages/index.d.mts +4 -0
- package/resources/messages/index.d.mts.map +1 -0
- package/resources/messages/index.d.ts +4 -0
- package/resources/messages/index.d.ts.map +1 -0
- package/resources/messages/index.js +11 -0
- package/resources/messages/index.js.map +1 -0
- package/resources/messages/index.mjs +5 -0
- package/resources/messages/index.mjs.map +1 -0
- package/resources/messages/messages.d.mts +778 -0
- package/resources/messages/messages.d.mts.map +1 -0
- package/resources/messages/messages.d.ts +778 -0
- package/resources/messages/messages.d.ts.map +1 -0
- package/resources/messages/messages.js +223 -0
- package/resources/messages/messages.js.map +1 -0
- package/resources/messages/messages.mjs +218 -0
- package/resources/messages/messages.mjs.map +1 -0
- package/resources/messages.d.mts +2 -0
- package/resources/messages.d.mts.map +1 -0
- package/resources/messages.d.ts +2 -0
- package/resources/messages.d.ts.map +1 -0
- package/resources/messages.js +6 -0
- package/resources/messages.js.map +1 -0
- package/resources/messages.mjs +3 -0
- package/resources/messages.mjs.map +1 -0
- package/resources/objects/bulk.d.mts +108 -0
- package/resources/objects/bulk.d.mts.map +1 -0
- package/resources/objects/bulk.d.ts +108 -0
- package/resources/objects/bulk.d.ts.map +1 -0
- package/resources/objects/bulk.js +81 -0
- package/resources/objects/bulk.js.map +1 -0
- package/resources/objects/bulk.mjs +77 -0
- package/resources/objects/bulk.mjs.map +1 -0
- package/resources/objects/index.d.mts +3 -0
- package/resources/objects/index.d.mts.map +1 -0
- package/resources/objects/index.d.ts +3 -0
- package/resources/objects/index.d.ts.map +1 -0
- package/resources/objects/index.js +9 -0
- package/resources/objects/index.js.map +1 -0
- package/resources/objects/index.mjs +4 -0
- package/resources/objects/index.mjs.map +1 -0
- package/resources/objects/objects.d.mts +560 -0
- package/resources/objects/objects.d.mts.map +1 -0
- package/resources/objects/objects.d.ts +560 -0
- package/resources/objects/objects.d.ts.map +1 -0
- package/resources/objects/objects.js +312 -0
- package/resources/objects/objects.js.map +1 -0
- package/resources/objects/objects.mjs +307 -0
- package/resources/objects/objects.mjs.map +1 -0
- package/resources/objects.d.mts +2 -0
- package/resources/objects.d.mts.map +1 -0
- package/resources/objects.d.ts +2 -0
- package/resources/objects.d.ts.map +1 -0
- package/resources/objects.js +6 -0
- package/resources/objects.js.map +1 -0
- package/resources/objects.mjs +3 -0
- package/resources/objects.mjs.map +1 -0
- package/resources/providers/index.d.mts +4 -0
- package/resources/providers/index.d.mts.map +1 -0
- package/resources/providers/index.d.ts +4 -0
- package/resources/providers/index.d.ts.map +1 -0
- package/resources/providers/index.js +11 -0
- package/resources/providers/index.js.map +1 -0
- package/resources/providers/index.mjs +5 -0
- package/resources/providers/index.mjs.map +1 -0
- package/resources/providers/ms-teams.d.mts +223 -0
- package/resources/providers/ms-teams.d.mts.map +1 -0
- package/resources/providers/ms-teams.d.ts +223 -0
- package/resources/providers/ms-teams.d.ts.map +1 -0
- package/resources/providers/ms-teams.js +82 -0
- package/resources/providers/ms-teams.js.map +1 -0
- package/resources/providers/ms-teams.mjs +78 -0
- package/resources/providers/ms-teams.mjs.map +1 -0
- package/resources/providers/providers.d.mts +14 -0
- package/resources/providers/providers.d.mts.map +1 -0
- package/resources/providers/providers.d.ts +14 -0
- package/resources/providers/providers.d.ts.map +1 -0
- package/resources/providers/providers.js +21 -0
- package/resources/providers/providers.js.map +1 -0
- package/resources/providers/providers.mjs +16 -0
- package/resources/providers/providers.mjs.map +1 -0
- package/resources/providers/slack.d.mts +154 -0
- package/resources/providers/slack.d.mts.map +1 -0
- package/resources/providers/slack.d.ts +154 -0
- package/resources/providers/slack.d.ts.map +1 -0
- package/resources/providers/slack.js +60 -0
- package/resources/providers/slack.js.map +1 -0
- package/resources/providers/slack.mjs +56 -0
- package/resources/providers/slack.mjs.map +1 -0
- package/resources/providers.d.mts +2 -0
- package/resources/providers.d.mts.map +1 -0
- package/resources/providers.d.ts +2 -0
- package/resources/providers.d.ts.map +1 -0
- package/resources/providers.js +6 -0
- package/resources/providers.js.map +1 -0
- package/resources/providers.mjs +3 -0
- package/resources/providers.mjs.map +1 -0
- package/resources/recipients/channel-data.d.mts +205 -0
- package/resources/recipients/channel-data.d.mts.map +1 -0
- package/resources/recipients/channel-data.d.ts +205 -0
- package/resources/recipients/channel-data.d.ts.map +1 -0
- package/resources/recipients/channel-data.js +9 -0
- package/resources/recipients/channel-data.js.map +1 -0
- package/resources/recipients/channel-data.mjs +5 -0
- package/resources/recipients/channel-data.mjs.map +1 -0
- package/resources/recipients/index.d.mts +5 -0
- package/resources/recipients/index.d.mts.map +1 -0
- package/resources/recipients/index.d.ts +5 -0
- package/resources/recipients/index.d.ts.map +1 -0
- package/resources/recipients/index.js +13 -0
- package/resources/recipients/index.js.map +1 -0
- package/resources/recipients/index.mjs +6 -0
- package/resources/recipients/index.mjs.map +1 -0
- package/resources/recipients/preferences.d.mts +155 -0
- package/resources/recipients/preferences.d.mts.map +1 -0
- package/resources/recipients/preferences.d.ts +155 -0
- package/resources/recipients/preferences.d.ts.map +1 -0
- package/resources/recipients/preferences.js +9 -0
- package/resources/recipients/preferences.js.map +1 -0
- package/resources/recipients/preferences.mjs +5 -0
- package/resources/recipients/preferences.mjs.map +1 -0
- package/resources/recipients/recipients.d.mts +51 -0
- package/resources/recipients/recipients.d.mts.map +1 -0
- package/resources/recipients/recipients.d.ts +51 -0
- package/resources/recipients/recipients.d.ts.map +1 -0
- package/resources/recipients/recipients.js +23 -0
- package/resources/recipients/recipients.js.map +1 -0
- package/resources/recipients/recipients.mjs +18 -0
- package/resources/recipients/recipients.mjs.map +1 -0
- package/resources/recipients/subscriptions.d.mts +40 -0
- package/resources/recipients/subscriptions.d.mts.map +1 -0
- package/resources/recipients/subscriptions.d.ts +40 -0
- package/resources/recipients/subscriptions.d.ts.map +1 -0
- package/resources/recipients/subscriptions.js +9 -0
- package/resources/recipients/subscriptions.js.map +1 -0
- package/resources/recipients/subscriptions.mjs +5 -0
- package/resources/recipients/subscriptions.mjs.map +1 -0
- package/resources/recipients.d.mts +2 -0
- package/resources/recipients.d.mts.map +1 -0
- package/resources/recipients.d.ts +2 -0
- package/resources/recipients.d.ts.map +1 -0
- package/resources/recipients.js +6 -0
- package/resources/recipients.js.map +1 -0
- package/resources/recipients.mjs +3 -0
- package/resources/recipients.mjs.map +1 -0
- package/resources/schedules/bulk.d.mts +98 -0
- package/resources/schedules/bulk.d.mts.map +1 -0
- package/resources/schedules/bulk.d.ts +98 -0
- package/resources/schedules/bulk.d.ts.map +1 -0
- package/resources/schedules/bulk.js +47 -0
- package/resources/schedules/bulk.js.map +1 -0
- package/resources/schedules/bulk.mjs +43 -0
- package/resources/schedules/bulk.mjs.map +1 -0
- package/resources/schedules/index.d.mts +3 -0
- package/resources/schedules/index.d.mts.map +1 -0
- package/resources/schedules/index.d.ts +3 -0
- package/resources/schedules/index.d.ts.map +1 -0
- package/resources/schedules/index.js +9 -0
- package/resources/schedules/index.js.map +1 -0
- package/resources/schedules/index.mjs +4 -0
- package/resources/schedules/index.mjs.map +1 -0
- package/resources/schedules/schedules.d.mts +299 -0
- package/resources/schedules/schedules.d.mts.map +1 -0
- package/resources/schedules/schedules.d.ts +299 -0
- package/resources/schedules/schedules.d.ts.map +1 -0
- package/resources/schedules/schedules.js +126 -0
- package/resources/schedules/schedules.js.map +1 -0
- package/resources/schedules/schedules.mjs +121 -0
- package/resources/schedules/schedules.mjs.map +1 -0
- package/resources/schedules.d.mts +2 -0
- package/resources/schedules.d.mts.map +1 -0
- package/resources/schedules.d.ts +2 -0
- package/resources/schedules.d.ts.map +1 -0
- package/resources/schedules.js +6 -0
- package/resources/schedules.js.map +1 -0
- package/resources/schedules.mjs +3 -0
- package/resources/schedules.mjs.map +1 -0
- package/resources/shared.d.mts +45 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +45 -0
- package/resources/shared.d.ts.map +1 -0
- package/resources/shared.js +9 -0
- package/resources/shared.js.map +1 -0
- package/resources/shared.mjs +5 -0
- package/resources/shared.mjs.map +1 -0
- package/resources/tenants/bulk.d.mts +45 -0
- package/resources/tenants/bulk.d.mts.map +1 -0
- package/resources/tenants/bulk.d.ts +45 -0
- package/resources/tenants/bulk.d.ts.map +1 -0
- package/resources/tenants/bulk.js +36 -0
- package/resources/tenants/bulk.js.map +1 -0
- package/resources/tenants/bulk.mjs +32 -0
- package/resources/tenants/bulk.mjs.map +1 -0
- package/resources/tenants/index.d.mts +3 -0
- package/resources/tenants/index.d.mts.map +1 -0
- package/resources/tenants/index.d.ts +3 -0
- package/resources/tenants/index.d.ts.map +1 -0
- package/resources/tenants/index.js +9 -0
- package/resources/tenants/index.js.map +1 -0
- package/resources/tenants/index.mjs +4 -0
- package/resources/tenants/index.mjs.map +1 -0
- package/resources/tenants/tenants.d.mts +266 -0
- package/resources/tenants/tenants.d.mts.map +1 -0
- package/resources/tenants/tenants.d.ts +266 -0
- package/resources/tenants/tenants.d.ts.map +1 -0
- package/resources/tenants/tenants.js +77 -0
- package/resources/tenants/tenants.js.map +1 -0
- package/resources/tenants/tenants.mjs +72 -0
- package/resources/tenants/tenants.mjs.map +1 -0
- package/resources/tenants.d.mts +2 -0
- package/resources/tenants.d.mts.map +1 -0
- package/resources/tenants.d.ts +2 -0
- package/resources/tenants.d.ts.map +1 -0
- package/resources/tenants.js +6 -0
- package/resources/tenants.js.map +1 -0
- package/resources/tenants.mjs +3 -0
- package/resources/tenants.mjs.map +1 -0
- package/resources/users/bulk.d.mts +92 -0
- package/resources/users/bulk.d.mts.map +1 -0
- package/resources/users/bulk.d.ts +92 -0
- package/resources/users/bulk.d.ts.map +1 -0
- package/resources/users/bulk.js +73 -0
- package/resources/users/bulk.js.map +1 -0
- package/resources/users/bulk.mjs +69 -0
- package/resources/users/bulk.mjs.map +1 -0
- package/resources/users/feeds.d.mts +248 -0
- package/resources/users/feeds.d.mts.map +1 -0
- package/resources/users/feeds.d.ts +248 -0
- package/resources/users/feeds.d.ts.map +1 -0
- package/resources/users/feeds.js +43 -0
- package/resources/users/feeds.js.map +1 -0
- package/resources/users/feeds.mjs +39 -0
- package/resources/users/feeds.mjs.map +1 -0
- package/resources/users/guides.d.mts +293 -0
- package/resources/users/guides.d.mts.map +1 -0
- package/resources/users/guides.d.ts +293 -0
- package/resources/users/guides.d.ts.map +1 -0
- package/resources/users/guides.js +114 -0
- package/resources/users/guides.js.map +1 -0
- package/resources/users/guides.mjs +110 -0
- package/resources/users/guides.mjs.map +1 -0
- package/resources/users/index.d.mts +5 -0
- package/resources/users/index.d.mts.map +1 -0
- package/resources/users/index.d.ts +5 -0
- package/resources/users/index.d.ts.map +1 -0
- package/resources/users/index.js +13 -0
- package/resources/users/index.js.map +1 -0
- package/resources/users/index.mjs +6 -0
- package/resources/users/index.mjs.map +1 -0
- package/resources/users/users.d.mts +585 -0
- package/resources/users/users.d.mts.map +1 -0
- package/resources/users/users.d.ts +585 -0
- package/resources/users/users.d.ts.map +1 -0
- package/resources/users/users.js +262 -0
- package/resources/users/users.js.map +1 -0
- package/resources/users/users.mjs +257 -0
- package/resources/users/users.mjs.map +1 -0
- package/resources/users.d.mts +2 -0
- package/resources/users.d.mts.map +1 -0
- package/resources/users.d.ts +2 -0
- package/resources/users.d.ts.map +1 -0
- package/resources/users.js +6 -0
- package/resources/users.js.map +1 -0
- package/resources/users.mjs +3 -0
- package/resources/users.mjs.map +1 -0
- package/resources/workflows.d.mts +113 -0
- package/resources/workflows.d.mts.map +1 -0
- package/resources/workflows.d.ts +113 -0
- package/resources/workflows.d.ts.map +1 -0
- package/resources/workflows.js +58 -0
- package/resources/workflows.js.map +1 -0
- package/resources/workflows.mjs +54 -0
- package/resources/workflows.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 +984 -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/pagination.ts +323 -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 +23 -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 +50 -0
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +9 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +388 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/request-options.ts +37 -0
- package/src/internal/shim-types.d.ts +28 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +92 -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 +63 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +102 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/lib/index.ts +6 -0
- package/src/lib/tokenSigner.ts +170 -0
- package/src/lib/userTokens.ts +38 -0
- package/src/pagination.ts +2 -0
- package/src/resource.ts +2 -0
- package/src/resources/audiences.ts +200 -0
- package/src/resources/bulk-operations.ts +120 -0
- package/src/resources/channels/bulk.ts +128 -0
- package/src/resources/channels/channels.ts +15 -0
- package/src/resources/channels/index.ts +4 -0
- package/src/resources/channels.ts +3 -0
- package/src/resources/index.ts +108 -0
- package/src/resources/integrations/census.ts +58 -0
- package/src/resources/integrations/hightouch.ts +58 -0
- package/src/resources/integrations/index.ts +9 -0
- package/src/resources/integrations/integrations.ts +33 -0
- package/src/resources/integrations.ts +3 -0
- package/src/resources/messages/activities.ts +48 -0
- package/src/resources/messages/batch.ts +575 -0
- package/src/resources/messages/index.ts +39 -0
- package/src/resources/messages/messages.ts +1055 -0
- package/src/resources/messages.ts +3 -0
- package/src/resources/objects/bulk.ts +141 -0
- package/src/resources/objects/index.ts +23 -0
- package/src/resources/objects/objects.ts +794 -0
- package/src/resources/objects.ts +3 -0
- package/src/resources/providers/index.ts +25 -0
- package/src/resources/providers/ms-teams.ts +300 -0
- package/src/resources/providers/providers.ts +61 -0
- package/src/resources/providers/slack.ts +213 -0
- package/src/resources/providers.ts +3 -0
- package/src/resources/recipients/channel-data.ts +255 -0
- package/src/resources/recipients/index.ts +22 -0
- package/src/resources/recipients/preferences.ts +192 -0
- package/src/resources/recipients/recipients.ts +101 -0
- package/src/resources/recipients/subscriptions.ts +49 -0
- package/src/resources/recipients.ts +3 -0
- package/src/resources/schedules/bulk.ts +112 -0
- package/src/resources/schedules/index.ts +16 -0
- package/src/resources/schedules/schedules.ts +369 -0
- package/src/resources/schedules.ts +3 -0
- package/src/resources/shared.ts +72 -0
- package/src/resources/tenants/bulk.ts +56 -0
- package/src/resources/tenants/index.ts +13 -0
- package/src/resources/tenants/tenants.ts +333 -0
- package/src/resources/tenants.ts +3 -0
- package/src/resources/users/bulk.ts +114 -0
- package/src/resources/users/feeds.ts +315 -0
- package/src/resources/users/guides.ts +386 -0
- package/src/resources/users/index.ts +40 -0
- package/src/resources/users/users.ts +823 -0
- package/src/resources/users.ts +3 -0
- package/src/resources/workflows.ts +140 -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
- package/dist/package.json +0 -48
- package/dist/src/common/exceptions.d.ts +0 -48
- package/dist/src/common/exceptions.js +0 -78
- package/dist/src/common/fetchClient.d.ts +0 -28
- package/dist/src/common/fetchClient.js +0 -148
- package/dist/src/common/interfaces.d.ts +0 -70
- package/dist/src/index.d.ts +0 -8
- package/dist/src/index.js +0 -26
- package/dist/src/knock.d.ts +0 -57
- package/dist/src/knock.js +0 -241
- package/dist/src/resources/activities/interfaces.d.ts +0 -11
- package/dist/src/resources/activities/interfaces.js +0 -2
- package/dist/src/resources/bulk_operations/index.d.ts +0 -7
- package/dist/src/resources/bulk_operations/index.js +0 -24
- package/dist/src/resources/bulk_operations/interfaces.d.ts +0 -12
- package/dist/src/resources/bulk_operations/interfaces.js +0 -2
- package/dist/src/resources/messages/index.d.ts +0 -16
- package/dist/src/resources/messages/index.js +0 -93
- package/dist/src/resources/messages/interfaces.d.ts +0 -58
- package/dist/src/resources/messages/interfaces.js +0 -2
- package/dist/src/resources/objects/index.d.ts +0 -36
- package/dist/src/resources/objects/index.js +0 -203
- package/dist/src/resources/objects/interfaces.d.ts +0 -51
- package/dist/src/resources/objects/interfaces.js +0 -2
- package/dist/src/resources/preferences/helpers.d.ts +0 -7
- package/dist/src/resources/preferences/helpers.js +0 -11
- package/dist/src/resources/preferences/interfaces.d.ts +0 -30
- package/dist/src/resources/preferences/interfaces.js +0 -2
- package/dist/src/resources/slack/index.d.ts +0 -9
- package/dist/src/resources/slack/index.js +0 -75
- package/dist/src/resources/slack/interfaces.d.ts +0 -30
- package/dist/src/resources/slack/interfaces.js +0 -2
- package/dist/src/resources/tenants/index.d.ts +0 -11
- package/dist/src/resources/tenants/index.js +0 -42
- package/dist/src/resources/tenants/interfaces.d.ts +0 -32
- package/dist/src/resources/tenants/interfaces.js +0 -2
- package/dist/src/resources/users/index.d.ts +0 -36
- package/dist/src/resources/users/index.js +0 -232
- package/dist/src/resources/users/interfaces.d.ts +0 -34
- package/dist/src/resources/users/interfaces.js +0 -2
- package/dist/src/resources/workflows/index.d.ts +0 -13
- package/dist/src/resources/workflows/index.js +0 -72
- package/dist/src/resources/workflows/interfaces.d.ts +0 -90
- package/dist/src/resources/workflows/interfaces.js +0 -20
|
@@ -0,0 +1,585 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as SharedAPI from "../shared.js";
|
|
3
|
+
import * as MessagesAPI from "../messages/messages.js";
|
|
4
|
+
import { MessagesEntriesCursor } from "../messages/messages.js";
|
|
5
|
+
import * as ChannelDataAPI from "../recipients/channel-data.js";
|
|
6
|
+
import * as PreferencesAPI from "../recipients/preferences.js";
|
|
7
|
+
import * as SubscriptionsAPI from "../recipients/subscriptions.js";
|
|
8
|
+
import { SubscriptionsEntriesCursor } from "../recipients/subscriptions.js";
|
|
9
|
+
import * as SchedulesAPI from "../schedules/schedules.js";
|
|
10
|
+
import { SchedulesEntriesCursor } from "../schedules/schedules.js";
|
|
11
|
+
import * as BulkAPI from "./bulk.js";
|
|
12
|
+
import { Bulk, BulkDeleteParams, BulkIdentifyParams, BulkSetPreferencesParams } from "./bulk.js";
|
|
13
|
+
import * as FeedsAPI from "./feeds.js";
|
|
14
|
+
import { FeedGetSettingsResponse, FeedListItemsParams, FeedListItemsResponse, FeedListItemsResponsesEntriesCursor, Feeds } from "./feeds.js";
|
|
15
|
+
import * as GuidesAPI from "./guides.js";
|
|
16
|
+
import { GuideGetChannelParams, GuideGetChannelResponse, GuideMarkMessageAsArchivedParams, GuideMarkMessageAsArchivedResponse, GuideMarkMessageAsInteractedParams, GuideMarkMessageAsInteractedResponse, GuideMarkMessageAsSeenParams, GuideMarkMessageAsSeenResponse, Guides } from "./guides.js";
|
|
17
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
18
|
+
import { EntriesCursor, type EntriesCursorParams, PagePromise } from "../../core/pagination.js";
|
|
19
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
20
|
+
export declare class Users extends APIResource {
|
|
21
|
+
feeds: FeedsAPI.Feeds;
|
|
22
|
+
guides: GuidesAPI.Guides;
|
|
23
|
+
bulk: BulkAPI.Bulk;
|
|
24
|
+
/**
|
|
25
|
+
* Create or update a user with the provided identification data. When you identify
|
|
26
|
+
* an existing user, the system merges the properties you specific with what is
|
|
27
|
+
* currently set on the user, updating only the fields included in your requests.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const user = await client.users.update('user_id', {
|
|
32
|
+
* channel_data: {
|
|
33
|
+
* '97c5837d-c65c-4d54-aa39-080eeb81c69d': {
|
|
34
|
+
* data: { tokens: ['push_token_123'] },
|
|
35
|
+
* },
|
|
36
|
+
* },
|
|
37
|
+
* email: 'ian.malcolm@chaos.theory',
|
|
38
|
+
* name: 'Dr. Ian Malcolm',
|
|
39
|
+
* preferences: {
|
|
40
|
+
* default: {
|
|
41
|
+
* channel_types: { email: true },
|
|
42
|
+
* workflows: {
|
|
43
|
+
* 'dinosaurs-loose': {
|
|
44
|
+
* channel_types: { email: true },
|
|
45
|
+
* },
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* },
|
|
49
|
+
* timezone: 'America/New_York',
|
|
50
|
+
* });
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
update(userID: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<User>;
|
|
54
|
+
/**
|
|
55
|
+
* Retrieve a paginated list of users in the environment. Defaults to 50 users per
|
|
56
|
+
* page.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* // Automatically fetches more pages as needed.
|
|
61
|
+
* for await (const user of client.users.list()) {
|
|
62
|
+
* // ...
|
|
63
|
+
* }
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
list(query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<UsersEntriesCursor, User>;
|
|
67
|
+
/**
|
|
68
|
+
* Permanently delete a user and all associated data.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const user = await client.users.delete('user_id');
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
delete(userID: string, options?: RequestOptions): APIPromise<string>;
|
|
76
|
+
/**
|
|
77
|
+
* Retrieve a specific user by their ID.
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* const user = await client.users.get('user_id');
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
get(userID: string, options?: RequestOptions): APIPromise<User>;
|
|
85
|
+
/**
|
|
86
|
+
* Retrieves the channel data for a specific user and channel ID.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const channelData = await client.users.getChannelData(
|
|
91
|
+
* 'user_id',
|
|
92
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
93
|
+
* );
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
getChannelData(userID: string, channelID: string, options?: RequestOptions): APIPromise<ChannelDataAPI.ChannelData>;
|
|
97
|
+
/**
|
|
98
|
+
* Retrieves a specific preference set for a user identified by the preference set
|
|
99
|
+
* ID.
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* const preferenceSet = await client.users.getPreferences(
|
|
104
|
+
* 'user_id',
|
|
105
|
+
* 'default',
|
|
106
|
+
* );
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
getPreferences(userID: string, id: string, query?: UserGetPreferencesParams | null | undefined, options?: RequestOptions): APIPromise<PreferencesAPI.PreferenceSet>;
|
|
110
|
+
/**
|
|
111
|
+
* Returns a paginated list of messages for a specific user. Allows filtering by
|
|
112
|
+
* message status and provides various sorting options. Messages outside the
|
|
113
|
+
* account's retention window will not be included in the results.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* // Automatically fetches more pages as needed.
|
|
118
|
+
* for await (const message of client.users.listMessages(
|
|
119
|
+
* 'user-123',
|
|
120
|
+
* )) {
|
|
121
|
+
* // ...
|
|
122
|
+
* }
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
listMessages(userID: string, query?: UserListMessagesParams | null | undefined, options?: RequestOptions): PagePromise<MessagesEntriesCursor, MessagesAPI.Message>;
|
|
126
|
+
/**
|
|
127
|
+
* Retrieves a list of all preference sets for a specific user.
|
|
128
|
+
*
|
|
129
|
+
* @example
|
|
130
|
+
* ```ts
|
|
131
|
+
* const preferenceSets = await client.users.listPreferences(
|
|
132
|
+
* 'user_id',
|
|
133
|
+
* );
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
listPreferences(userID: string, options?: RequestOptions): APIPromise<UserListPreferencesResponse>;
|
|
137
|
+
/**
|
|
138
|
+
* Returns a paginated list of schedules for a specific user, in descending order.
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```ts
|
|
142
|
+
* // Automatically fetches more pages as needed.
|
|
143
|
+
* for await (const schedule of client.users.listSchedules(
|
|
144
|
+
* 'user_id',
|
|
145
|
+
* )) {
|
|
146
|
+
* // ...
|
|
147
|
+
* }
|
|
148
|
+
* ```
|
|
149
|
+
*/
|
|
150
|
+
listSchedules(userID: string, query?: UserListSchedulesParams | null | undefined, options?: RequestOptions): PagePromise<SchedulesEntriesCursor, SchedulesAPI.Schedule>;
|
|
151
|
+
/**
|
|
152
|
+
* Retrieves a paginated list of subscriptions for a specific user, in descending
|
|
153
|
+
* order.
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```ts
|
|
157
|
+
* // Automatically fetches more pages as needed.
|
|
158
|
+
* for await (const subscription of client.users.listSubscriptions(
|
|
159
|
+
* 'user_id',
|
|
160
|
+
* )) {
|
|
161
|
+
* // ...
|
|
162
|
+
* }
|
|
163
|
+
* ```
|
|
164
|
+
*/
|
|
165
|
+
listSubscriptions(userID: string, query?: UserListSubscriptionsParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionsEntriesCursor, SubscriptionsAPI.Subscription>;
|
|
166
|
+
/**
|
|
167
|
+
* Merge two users together, where the user specified with the `from_user_id` param
|
|
168
|
+
* will be merged into the user specified by `user_id`.
|
|
169
|
+
*
|
|
170
|
+
* @example
|
|
171
|
+
* ```ts
|
|
172
|
+
* const user = await client.users.merge('user_id', {
|
|
173
|
+
* from_user_id: 'user_1',
|
|
174
|
+
* });
|
|
175
|
+
* ```
|
|
176
|
+
*/
|
|
177
|
+
merge(userID: string, body: UserMergeParams, options?: RequestOptions): APIPromise<User>;
|
|
178
|
+
/**
|
|
179
|
+
* Updates or creates channel data for a specific user and channel ID.
|
|
180
|
+
*
|
|
181
|
+
* @example
|
|
182
|
+
* ```ts
|
|
183
|
+
* const channelData = await client.users.setChannelData(
|
|
184
|
+
* 'user_id',
|
|
185
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
186
|
+
* { data: { tokens: ['push_token_1'] } },
|
|
187
|
+
* );
|
|
188
|
+
* ```
|
|
189
|
+
*/
|
|
190
|
+
setChannelData(userID: string, channelID: string, body: UserSetChannelDataParams, options?: RequestOptions): APIPromise<ChannelDataAPI.ChannelData>;
|
|
191
|
+
/**
|
|
192
|
+
* Updates a complete preference set for a user. This is a destructive operation
|
|
193
|
+
* that will replace the existing preference set for the user.
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* ```ts
|
|
197
|
+
* const preferenceSet = await client.users.setPreferences(
|
|
198
|
+
* 'user_id',
|
|
199
|
+
* 'default',
|
|
200
|
+
* {
|
|
201
|
+
* categories: {
|
|
202
|
+
* marketing: false,
|
|
203
|
+
* transactional: { channel_types: { email: false } },
|
|
204
|
+
* },
|
|
205
|
+
* channel_types: { email: true },
|
|
206
|
+
* workflows: {
|
|
207
|
+
* 'dinosaurs-loose': {
|
|
208
|
+
* channel_types: { email: false },
|
|
209
|
+
* },
|
|
210
|
+
* },
|
|
211
|
+
* },
|
|
212
|
+
* );
|
|
213
|
+
* ```
|
|
214
|
+
*/
|
|
215
|
+
setPreferences(userID: string, id: string, body: UserSetPreferencesParams, options?: RequestOptions): APIPromise<PreferencesAPI.PreferenceSet>;
|
|
216
|
+
/**
|
|
217
|
+
* Deletes channel data for a specific user and channel ID.
|
|
218
|
+
*
|
|
219
|
+
* @example
|
|
220
|
+
* ```ts
|
|
221
|
+
* const response = await client.users.unsetChannelData(
|
|
222
|
+
* 'user_id',
|
|
223
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
224
|
+
* );
|
|
225
|
+
* ```
|
|
226
|
+
*/
|
|
227
|
+
unsetChannelData(userID: string, channelID: string, options?: RequestOptions): APIPromise<string>;
|
|
228
|
+
}
|
|
229
|
+
export type UsersEntriesCursor = EntriesCursor<User>;
|
|
230
|
+
/**
|
|
231
|
+
* A set of parameters to identify a user with. Does not include the user ID, as
|
|
232
|
+
* that's specified elsewhere in the request. You can supply any additional
|
|
233
|
+
* properties you'd like to upsert for the user.
|
|
234
|
+
*/
|
|
235
|
+
export interface IdentifyUserRequest {
|
|
236
|
+
/**
|
|
237
|
+
* URL to the user's avatar image.
|
|
238
|
+
*/
|
|
239
|
+
avatar?: string | null;
|
|
240
|
+
/**
|
|
241
|
+
* A request to set channel data for a type of channel inline.
|
|
242
|
+
*/
|
|
243
|
+
channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
|
|
244
|
+
/**
|
|
245
|
+
* The creation date of the user from your system.
|
|
246
|
+
*/
|
|
247
|
+
created_at?: string | null;
|
|
248
|
+
/**
|
|
249
|
+
* The primary email address for the user.
|
|
250
|
+
*/
|
|
251
|
+
email?: string | null;
|
|
252
|
+
/**
|
|
253
|
+
* The locale of the user. Used for [message localization](/concepts/translations).
|
|
254
|
+
*/
|
|
255
|
+
locale?: string | null;
|
|
256
|
+
/**
|
|
257
|
+
* Display name of the user.
|
|
258
|
+
*/
|
|
259
|
+
name?: string | null;
|
|
260
|
+
/**
|
|
261
|
+
* The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
|
262
|
+
* user (required for SMS channels).
|
|
263
|
+
*/
|
|
264
|
+
phone_number?: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* Inline set preferences for a recipient, where the key is the preference set id.
|
|
267
|
+
*/
|
|
268
|
+
preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
|
|
269
|
+
/**
|
|
270
|
+
* The timezone of the user. Must be a
|
|
271
|
+
* valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
272
|
+
* Used
|
|
273
|
+
* for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
274
|
+
*/
|
|
275
|
+
timezone?: string | null;
|
|
276
|
+
[k: string]: unknown;
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* A set of parameters to inline-identify a user with. Inline identifying the user
|
|
280
|
+
* will ensure that the user is available before the request is executed in Knock.
|
|
281
|
+
* It will perform an upsert for the user you're supplying, replacing any
|
|
282
|
+
* properties specified.
|
|
283
|
+
*/
|
|
284
|
+
export interface InlineIdentifyUserRequest {
|
|
285
|
+
/**
|
|
286
|
+
* The ID for the user that you set when identifying them in Knock.
|
|
287
|
+
*/
|
|
288
|
+
id: string;
|
|
289
|
+
/**
|
|
290
|
+
* A request to set channel data for a type of channel inline.
|
|
291
|
+
*/
|
|
292
|
+
channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
|
|
293
|
+
/**
|
|
294
|
+
* The creation date of the user from your system.
|
|
295
|
+
*/
|
|
296
|
+
created_at?: string | null;
|
|
297
|
+
/**
|
|
298
|
+
* The primary email address for the user.
|
|
299
|
+
*/
|
|
300
|
+
email?: string | null;
|
|
301
|
+
/**
|
|
302
|
+
* Display name of the user.
|
|
303
|
+
*/
|
|
304
|
+
name?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* Inline set preferences for a recipient, where the key is the preference set id.
|
|
307
|
+
*/
|
|
308
|
+
preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
|
|
309
|
+
/**
|
|
310
|
+
* The timezone of the user. Must be a
|
|
311
|
+
* valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
312
|
+
* Used
|
|
313
|
+
* for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
314
|
+
*/
|
|
315
|
+
timezone?: string | null;
|
|
316
|
+
[k: string]: unknown;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* A [User](/concepts/users) represents an individual in your system who can
|
|
320
|
+
* receive notifications through Knock. Users are the most common recipients of
|
|
321
|
+
* notifications and are always referenced by your internal identifier.
|
|
322
|
+
*/
|
|
323
|
+
export interface User {
|
|
324
|
+
/**
|
|
325
|
+
* The ID for the user that you set when identifying them in Knock.
|
|
326
|
+
*/
|
|
327
|
+
id: string;
|
|
328
|
+
/**
|
|
329
|
+
* The typename of the schema.
|
|
330
|
+
*/
|
|
331
|
+
__typename: string;
|
|
332
|
+
/**
|
|
333
|
+
* The timestamp when the resource was last updated.
|
|
334
|
+
*/
|
|
335
|
+
updated_at: string;
|
|
336
|
+
/**
|
|
337
|
+
* URL to the user's avatar image.
|
|
338
|
+
*/
|
|
339
|
+
avatar?: string | null;
|
|
340
|
+
/**
|
|
341
|
+
* The creation date of the user from your system.
|
|
342
|
+
*/
|
|
343
|
+
created_at?: string | null;
|
|
344
|
+
/**
|
|
345
|
+
* The primary email address for the user.
|
|
346
|
+
*/
|
|
347
|
+
email?: string | null;
|
|
348
|
+
/**
|
|
349
|
+
* Display name of the user.
|
|
350
|
+
*/
|
|
351
|
+
name?: string | null;
|
|
352
|
+
/**
|
|
353
|
+
* The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
|
354
|
+
* user (required for SMS channels).
|
|
355
|
+
*/
|
|
356
|
+
phone_number?: string | null;
|
|
357
|
+
/**
|
|
358
|
+
* The timezone of the user. Must be a
|
|
359
|
+
* valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
360
|
+
* Used
|
|
361
|
+
* for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
362
|
+
*/
|
|
363
|
+
timezone?: string | null;
|
|
364
|
+
[k: string]: unknown;
|
|
365
|
+
}
|
|
366
|
+
/**
|
|
367
|
+
* A `204 No Content` response.
|
|
368
|
+
*/
|
|
369
|
+
export type UserDeleteResponse = string;
|
|
370
|
+
/**
|
|
371
|
+
* A list of preference sets for the user.
|
|
372
|
+
*/
|
|
373
|
+
export type UserListPreferencesResponse = Array<PreferencesAPI.PreferenceSet>;
|
|
374
|
+
/**
|
|
375
|
+
* A `204 No Content` response.
|
|
376
|
+
*/
|
|
377
|
+
export type UserUnsetChannelDataResponse = string;
|
|
378
|
+
export interface UserUpdateParams {
|
|
379
|
+
/**
|
|
380
|
+
* URL to the user's avatar image.
|
|
381
|
+
*/
|
|
382
|
+
avatar?: string | null;
|
|
383
|
+
/**
|
|
384
|
+
* A request to set channel data for a type of channel inline.
|
|
385
|
+
*/
|
|
386
|
+
channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
|
|
387
|
+
/**
|
|
388
|
+
* The creation date of the user from your system.
|
|
389
|
+
*/
|
|
390
|
+
created_at?: string | null;
|
|
391
|
+
/**
|
|
392
|
+
* The primary email address for the user.
|
|
393
|
+
*/
|
|
394
|
+
email?: string | null;
|
|
395
|
+
/**
|
|
396
|
+
* The locale of the user. Used for [message localization](/concepts/translations).
|
|
397
|
+
*/
|
|
398
|
+
locale?: string | null;
|
|
399
|
+
/**
|
|
400
|
+
* Display name of the user.
|
|
401
|
+
*/
|
|
402
|
+
name?: string | null;
|
|
403
|
+
/**
|
|
404
|
+
* The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
|
405
|
+
* user (required for SMS channels).
|
|
406
|
+
*/
|
|
407
|
+
phone_number?: string | null;
|
|
408
|
+
/**
|
|
409
|
+
* Inline set preferences for a recipient, where the key is the preference set id.
|
|
410
|
+
*/
|
|
411
|
+
preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
|
|
412
|
+
/**
|
|
413
|
+
* The timezone of the user. Must be a
|
|
414
|
+
* valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
415
|
+
* Used
|
|
416
|
+
* for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
417
|
+
*/
|
|
418
|
+
timezone?: string | null;
|
|
419
|
+
[k: string]: unknown;
|
|
420
|
+
}
|
|
421
|
+
export interface UserListParams extends EntriesCursorParams {
|
|
422
|
+
/**
|
|
423
|
+
* Associated resources to include in the response.
|
|
424
|
+
*/
|
|
425
|
+
include?: Array<'preferences'>;
|
|
426
|
+
}
|
|
427
|
+
export interface UserGetPreferencesParams {
|
|
428
|
+
/**
|
|
429
|
+
* The unique identifier for the tenant.
|
|
430
|
+
*/
|
|
431
|
+
tenant?: string;
|
|
432
|
+
}
|
|
433
|
+
export interface UserListMessagesParams extends EntriesCursorParams {
|
|
434
|
+
/**
|
|
435
|
+
* Limits the results to items with the corresponding channel ID.
|
|
436
|
+
*/
|
|
437
|
+
channel_id?: string;
|
|
438
|
+
/**
|
|
439
|
+
* Limits the results to messages with the given engagement status.
|
|
440
|
+
*/
|
|
441
|
+
engagement_status?: Array<'seen' | 'read' | 'interacted' | 'link_clicked' | 'archived'>;
|
|
442
|
+
inserted_at?: UserListMessagesParams.InsertedAt;
|
|
443
|
+
/**
|
|
444
|
+
* Limits the results to only the message IDs given (max 50). Note: when using this
|
|
445
|
+
* option, the results will be subject to any other filters applied to the query.
|
|
446
|
+
*/
|
|
447
|
+
message_ids?: Array<string>;
|
|
448
|
+
/**
|
|
449
|
+
* Limits the results to messages triggered by the given workflow key.
|
|
450
|
+
*/
|
|
451
|
+
source?: string;
|
|
452
|
+
/**
|
|
453
|
+
* Limits the results to messages with the given delivery status.
|
|
454
|
+
*/
|
|
455
|
+
status?: Array<'queued' | 'sent' | 'delivered' | 'delivery_attempted' | 'undelivered' | 'not_sent' | 'bounced'>;
|
|
456
|
+
/**
|
|
457
|
+
* Limits the results to items with the corresponding tenant.
|
|
458
|
+
*/
|
|
459
|
+
tenant?: string;
|
|
460
|
+
/**
|
|
461
|
+
* Limits the results to only messages that were generated with the given data. See
|
|
462
|
+
* [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
|
|
463
|
+
* more information.
|
|
464
|
+
*/
|
|
465
|
+
trigger_data?: string;
|
|
466
|
+
/**
|
|
467
|
+
* Limits the results to messages related to any of the provided categories.
|
|
468
|
+
*/
|
|
469
|
+
workflow_categories?: Array<string>;
|
|
470
|
+
/**
|
|
471
|
+
* Limits the results to messages for a specific recipient's workflow run.
|
|
472
|
+
*/
|
|
473
|
+
workflow_recipient_run_id?: string;
|
|
474
|
+
/**
|
|
475
|
+
* Limits the results to messages associated with the top-level workflow run ID
|
|
476
|
+
* returned by the workflow trigger request.
|
|
477
|
+
*/
|
|
478
|
+
workflow_run_id?: string;
|
|
479
|
+
}
|
|
480
|
+
export declare namespace UserListMessagesParams {
|
|
481
|
+
interface InsertedAt {
|
|
482
|
+
/**
|
|
483
|
+
* Limits the results to messages inserted after the given date.
|
|
484
|
+
*/
|
|
485
|
+
gt?: string;
|
|
486
|
+
/**
|
|
487
|
+
* Limits the results to messages inserted after or on the given date.
|
|
488
|
+
*/
|
|
489
|
+
gte?: string;
|
|
490
|
+
/**
|
|
491
|
+
* Limits the results to messages inserted before the given date.
|
|
492
|
+
*/
|
|
493
|
+
lt?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Limits the results to messages inserted before or on the given date.
|
|
496
|
+
*/
|
|
497
|
+
lte?: string;
|
|
498
|
+
}
|
|
499
|
+
}
|
|
500
|
+
export interface UserListSchedulesParams extends EntriesCursorParams {
|
|
501
|
+
/**
|
|
502
|
+
* The tenant ID to filter schedules for.
|
|
503
|
+
*/
|
|
504
|
+
tenant?: string;
|
|
505
|
+
/**
|
|
506
|
+
* The workflow key to filter schedules for.
|
|
507
|
+
*/
|
|
508
|
+
workflow?: string;
|
|
509
|
+
}
|
|
510
|
+
export interface UserListSubscriptionsParams extends EntriesCursorParams {
|
|
511
|
+
/**
|
|
512
|
+
* Associated resources to include in the response.
|
|
513
|
+
*/
|
|
514
|
+
include?: Array<'preferences'>;
|
|
515
|
+
/**
|
|
516
|
+
* Only returns subscriptions for the specified object GIDs.
|
|
517
|
+
*/
|
|
518
|
+
objects?: Array<string>;
|
|
519
|
+
}
|
|
520
|
+
export interface UserMergeParams {
|
|
521
|
+
/**
|
|
522
|
+
* The user ID to merge from.
|
|
523
|
+
*/
|
|
524
|
+
from_user_id: string;
|
|
525
|
+
}
|
|
526
|
+
export interface UserSetChannelDataParams {
|
|
527
|
+
/**
|
|
528
|
+
* Channel data for a given channel type.
|
|
529
|
+
*/
|
|
530
|
+
data: ChannelDataAPI.PushChannelData | ChannelDataAPI.OneSignalChannelData | ChannelDataAPI.SlackChannelData | ChannelDataAPI.MsTeamsChannelData | ChannelDataAPI.DiscordChannelData;
|
|
531
|
+
}
|
|
532
|
+
export interface UserSetPreferencesParams {
|
|
533
|
+
/**
|
|
534
|
+
* An object where the key is the category and the values are the preference
|
|
535
|
+
* settings for that category.
|
|
536
|
+
*/
|
|
537
|
+
categories?: Record<string, boolean | UserSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject> | null;
|
|
538
|
+
/**
|
|
539
|
+
* Channel type preferences.
|
|
540
|
+
*/
|
|
541
|
+
channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
|
|
542
|
+
/**
|
|
543
|
+
* An object where the key is the workflow key and the values are the preference
|
|
544
|
+
* settings for that workflow.
|
|
545
|
+
*/
|
|
546
|
+
workflows?: Record<string, boolean | UserSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject> | null;
|
|
547
|
+
}
|
|
548
|
+
export declare namespace UserSetPreferencesParams {
|
|
549
|
+
/**
|
|
550
|
+
* The settings object for a workflow or category, where you can specify channel
|
|
551
|
+
* types or conditions.
|
|
552
|
+
*/
|
|
553
|
+
interface PreferenceSetWorkflowCategorySettingObject {
|
|
554
|
+
/**
|
|
555
|
+
* Channel type preferences.
|
|
556
|
+
*/
|
|
557
|
+
channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
|
|
558
|
+
/**
|
|
559
|
+
* A list of conditions to apply to a channel type.
|
|
560
|
+
*/
|
|
561
|
+
conditions?: Array<SharedAPI.Condition> | null;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* The settings object for a workflow or category, where you can specify channel
|
|
565
|
+
* types or conditions.
|
|
566
|
+
*/
|
|
567
|
+
interface PreferenceSetWorkflowCategorySettingObject {
|
|
568
|
+
/**
|
|
569
|
+
* Channel type preferences.
|
|
570
|
+
*/
|
|
571
|
+
channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
|
|
572
|
+
/**
|
|
573
|
+
* A list of conditions to apply to a channel type.
|
|
574
|
+
*/
|
|
575
|
+
conditions?: Array<SharedAPI.Condition> | null;
|
|
576
|
+
}
|
|
577
|
+
}
|
|
578
|
+
export declare namespace Users {
|
|
579
|
+
export { type IdentifyUserRequest as IdentifyUserRequest, type InlineIdentifyUserRequest as InlineIdentifyUserRequest, type User as User, type UserDeleteResponse as UserDeleteResponse, type UserListPreferencesResponse as UserListPreferencesResponse, type UserUnsetChannelDataResponse as UserUnsetChannelDataResponse, type UsersEntriesCursor as UsersEntriesCursor, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, type UserGetPreferencesParams as UserGetPreferencesParams, type UserListMessagesParams as UserListMessagesParams, type UserListSchedulesParams as UserListSchedulesParams, type UserListSubscriptionsParams as UserListSubscriptionsParams, type UserMergeParams as UserMergeParams, type UserSetChannelDataParams as UserSetChannelDataParams, type UserSetPreferencesParams as UserSetPreferencesParams, };
|
|
580
|
+
export { Feeds as Feeds, type FeedGetSettingsResponse as FeedGetSettingsResponse, type FeedListItemsResponse as FeedListItemsResponse, type FeedListItemsResponsesEntriesCursor as FeedListItemsResponsesEntriesCursor, type FeedListItemsParams as FeedListItemsParams, };
|
|
581
|
+
export { Guides as Guides, type GuideGetChannelResponse as GuideGetChannelResponse, type GuideMarkMessageAsArchivedResponse as GuideMarkMessageAsArchivedResponse, type GuideMarkMessageAsInteractedResponse as GuideMarkMessageAsInteractedResponse, type GuideMarkMessageAsSeenResponse as GuideMarkMessageAsSeenResponse, type GuideGetChannelParams as GuideGetChannelParams, type GuideMarkMessageAsArchivedParams as GuideMarkMessageAsArchivedParams, type GuideMarkMessageAsInteractedParams as GuideMarkMessageAsInteractedParams, type GuideMarkMessageAsSeenParams as GuideMarkMessageAsSeenParams, };
|
|
582
|
+
export { Bulk as Bulk, type BulkDeleteParams as BulkDeleteParams, type BulkIdentifyParams as BulkIdentifyParams, type BulkSetPreferencesParams as BulkSetPreferencesParams, };
|
|
583
|
+
}
|
|
584
|
+
export { type MessagesEntriesCursor, type SchedulesEntriesCursor, type SubscriptionsEntriesCursor };
|
|
585
|
+
//# sourceMappingURL=users.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,WAAW;OAChB,EAAE,qBAAqB,EAAE;OACzB,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,gBAAgB;OACrB,EAAE,0BAA0B,EAAE;OAC9B,KAAK,YAAY;OACjB,EAAE,sBAAsB,EAAE;OAC1B,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE;OACxE,KAAK,QAAQ;OACb,EACL,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,mCAAmC,EACnC,KAAK,EACN;OACM,KAAK,SAAS;OACd,EACL,qBAAqB,EACrB,uBAAuB,EACvB,gCAAgC,EAChC,kCAAkC,EAClC,kCAAkC,EAClC,oCAAoC,EACpC,4BAA4B,EAC5B,8BAA8B,EAC9B,MAAM,EACP;OACM,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAIxC;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIpE;;;;;;;OAOG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI/D;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAIzC;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAI3C;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,WAAW,CAAC,OAAO,CAAC;IAO1D;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,YAAY,CAAC,QAAQ,CAAC;IAQ7D;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAQzE;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIxF;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAIzC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAI3C;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGlG;AAED,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAElD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU,CAAC,CAAC;IAExF,WAAW,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAEhD;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACZ,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,oBAAoB,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAChG,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EACA,cAAc,CAAC,eAAe,GAC9B,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,gBAAgB,GAC/B,cAAc,CAAC,kBAAkB,GACjC,cAAc,CAAC,kBAAkB,CAAC;CACvC;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN,OAAO,GAAG,wBAAwB,CAAC,0CAA0C,CAC9E,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAChB,MAAM,EACN,OAAO,GAAG,wBAAwB,CAAC,0CAA0C,CAC9E,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;CACF;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,KAAK,0BAA0B,EAAE,CAAC"}
|