@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,266 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as ChannelDataAPI from "../recipients/channel-data.js";
|
|
3
|
+
import * as PreferencesAPI from "../recipients/preferences.js";
|
|
4
|
+
import * as BulkAPI from "./bulk.js";
|
|
5
|
+
import { Bulk, BulkDeleteParams, BulkSetParams } from "./bulk.js";
|
|
6
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
7
|
+
import { EntriesCursor, type EntriesCursorParams, PagePromise } from "../../core/pagination.js";
|
|
8
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
9
|
+
export declare class Tenants extends APIResource {
|
|
10
|
+
bulk: BulkAPI.Bulk;
|
|
11
|
+
/**
|
|
12
|
+
* List tenants for the current environment.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* // Automatically fetches more pages as needed.
|
|
17
|
+
* for await (const tenant of client.tenants.list()) {
|
|
18
|
+
* // ...
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
list(query?: TenantListParams | null | undefined, options?: RequestOptions): PagePromise<TenantsEntriesCursor, Tenant>;
|
|
23
|
+
/**
|
|
24
|
+
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const tenant = await client.tenants.delete('id');
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
delete(id: string, options?: RequestOptions): APIPromise<string>;
|
|
32
|
+
/**
|
|
33
|
+
* Get a tenant by ID.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const tenant = await client.tenants.get('id');
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
get(id: string, options?: RequestOptions): APIPromise<Tenant>;
|
|
41
|
+
/**
|
|
42
|
+
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
43
|
+
* existing properties will be merged with the incoming properties.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const tenant = await client.tenants.set('id', {
|
|
48
|
+
* settings: {
|
|
49
|
+
* branding: {
|
|
50
|
+
* icon_url:
|
|
51
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
52
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
53
|
+
* primary_color: '#DF1A22',
|
|
54
|
+
* primary_color_contrast: '#FFDE00',
|
|
55
|
+
* },
|
|
56
|
+
* },
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
set(id: string, body: TenantSetParams, options?: RequestOptions): APIPromise<Tenant>;
|
|
61
|
+
}
|
|
62
|
+
export type TenantsEntriesCursor = EntriesCursor<Tenant>;
|
|
63
|
+
/**
|
|
64
|
+
* An request to set a tenant inline.
|
|
65
|
+
*/
|
|
66
|
+
export type InlineTenantRequest = string | TenantRequest;
|
|
67
|
+
/**
|
|
68
|
+
* A tenant entity.
|
|
69
|
+
*/
|
|
70
|
+
export interface Tenant {
|
|
71
|
+
/**
|
|
72
|
+
* The unique identifier for the tenant.
|
|
73
|
+
*/
|
|
74
|
+
id: string;
|
|
75
|
+
/**
|
|
76
|
+
* The typename of the schema.
|
|
77
|
+
*/
|
|
78
|
+
__typename: string;
|
|
79
|
+
/**
|
|
80
|
+
* An optional name for the tenant.
|
|
81
|
+
*/
|
|
82
|
+
name?: string | null;
|
|
83
|
+
/**
|
|
84
|
+
* The settings for the tenant. Includes branding and preference set.
|
|
85
|
+
*/
|
|
86
|
+
settings?: Tenant.Settings | null;
|
|
87
|
+
[k: string]: unknown;
|
|
88
|
+
}
|
|
89
|
+
export declare namespace Tenant {
|
|
90
|
+
/**
|
|
91
|
+
* The settings for the tenant. Includes branding and preference set.
|
|
92
|
+
*/
|
|
93
|
+
interface Settings {
|
|
94
|
+
/**
|
|
95
|
+
* The branding for the tenant.
|
|
96
|
+
*/
|
|
97
|
+
branding?: Settings.Branding | null;
|
|
98
|
+
/**
|
|
99
|
+
* A preference set represents a specific set of notification preferences for a
|
|
100
|
+
* recipient. A recipient can have multiple preference sets.
|
|
101
|
+
*/
|
|
102
|
+
preference_set?: PreferencesAPI.PreferenceSet | null;
|
|
103
|
+
}
|
|
104
|
+
namespace Settings {
|
|
105
|
+
/**
|
|
106
|
+
* The branding for the tenant.
|
|
107
|
+
*/
|
|
108
|
+
interface Branding {
|
|
109
|
+
/**
|
|
110
|
+
* The icon URL for the tenant. Must point to a valid image with an image MIME
|
|
111
|
+
* type.
|
|
112
|
+
*/
|
|
113
|
+
icon_url?: string | null;
|
|
114
|
+
/**
|
|
115
|
+
* The logo URL for the tenant. Must point to a valid image with an image MIME
|
|
116
|
+
* type.
|
|
117
|
+
*/
|
|
118
|
+
logo_url?: string | null;
|
|
119
|
+
/**
|
|
120
|
+
* The primary color for the tenant, provided as a hex value.
|
|
121
|
+
*/
|
|
122
|
+
primary_color?: string | null;
|
|
123
|
+
/**
|
|
124
|
+
* The primary color contrast for the tenant, provided as a hex value.
|
|
125
|
+
*/
|
|
126
|
+
primary_color_contrast?: string | null;
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* A tenant to be set in the system. You can supply any additional properties on
|
|
132
|
+
* the tenant object.
|
|
133
|
+
*/
|
|
134
|
+
export interface TenantRequest {
|
|
135
|
+
/**
|
|
136
|
+
* The unique identifier for the tenant.
|
|
137
|
+
*/
|
|
138
|
+
id: string;
|
|
139
|
+
/**
|
|
140
|
+
* A request to set channel data for a type of channel inline.
|
|
141
|
+
*/
|
|
142
|
+
channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
|
|
143
|
+
/**
|
|
144
|
+
* Inline set preferences for a recipient, where the key is the preference set id.
|
|
145
|
+
*/
|
|
146
|
+
preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
|
|
147
|
+
/**
|
|
148
|
+
* The settings for the tenant. Includes branding and preference set.
|
|
149
|
+
*/
|
|
150
|
+
settings?: TenantRequest.Settings;
|
|
151
|
+
[k: string]: unknown;
|
|
152
|
+
}
|
|
153
|
+
export declare namespace TenantRequest {
|
|
154
|
+
/**
|
|
155
|
+
* The settings for the tenant. Includes branding and preference set.
|
|
156
|
+
*/
|
|
157
|
+
interface Settings {
|
|
158
|
+
/**
|
|
159
|
+
* The branding for the tenant.
|
|
160
|
+
*/
|
|
161
|
+
branding?: Settings.Branding;
|
|
162
|
+
/**
|
|
163
|
+
* A request to set a preference set for a recipient.
|
|
164
|
+
*/
|
|
165
|
+
preference_set?: PreferencesAPI.PreferenceSetRequest | null;
|
|
166
|
+
}
|
|
167
|
+
namespace Settings {
|
|
168
|
+
/**
|
|
169
|
+
* The branding for the tenant.
|
|
170
|
+
*/
|
|
171
|
+
interface Branding {
|
|
172
|
+
/**
|
|
173
|
+
* The icon URL for the tenant. Must point to a valid image with an image MIME
|
|
174
|
+
* type.
|
|
175
|
+
*/
|
|
176
|
+
icon_url?: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* The logo URL for the tenant. Must point to a valid image with an image MIME
|
|
179
|
+
* type.
|
|
180
|
+
*/
|
|
181
|
+
logo_url?: string | null;
|
|
182
|
+
/**
|
|
183
|
+
* The primary color for the tenant, provided as a hex value.
|
|
184
|
+
*/
|
|
185
|
+
primary_color?: string | null;
|
|
186
|
+
/**
|
|
187
|
+
* The primary color contrast for the tenant, provided as a hex value.
|
|
188
|
+
*/
|
|
189
|
+
primary_color_contrast?: string | null;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* A `204 No Content` response.
|
|
195
|
+
*/
|
|
196
|
+
export type TenantDeleteResponse = string;
|
|
197
|
+
export interface TenantListParams extends EntriesCursorParams {
|
|
198
|
+
/**
|
|
199
|
+
* Filter tenants by name.
|
|
200
|
+
*/
|
|
201
|
+
name?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Filter tenants by ID.
|
|
204
|
+
*/
|
|
205
|
+
tenant_id?: string;
|
|
206
|
+
}
|
|
207
|
+
export interface TenantSetParams {
|
|
208
|
+
/**
|
|
209
|
+
* A request to set channel data for a type of channel inline.
|
|
210
|
+
*/
|
|
211
|
+
channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
|
|
212
|
+
/**
|
|
213
|
+
* Inline set preferences for a recipient, where the key is the preference set id.
|
|
214
|
+
*/
|
|
215
|
+
preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
|
|
216
|
+
/**
|
|
217
|
+
* The settings for the tenant. Includes branding and preference set.
|
|
218
|
+
*/
|
|
219
|
+
settings?: TenantSetParams.Settings;
|
|
220
|
+
[k: string]: unknown;
|
|
221
|
+
}
|
|
222
|
+
export declare namespace TenantSetParams {
|
|
223
|
+
/**
|
|
224
|
+
* The settings for the tenant. Includes branding and preference set.
|
|
225
|
+
*/
|
|
226
|
+
interface Settings {
|
|
227
|
+
/**
|
|
228
|
+
* The branding for the tenant.
|
|
229
|
+
*/
|
|
230
|
+
branding?: Settings.Branding;
|
|
231
|
+
/**
|
|
232
|
+
* A request to set a preference set for a recipient.
|
|
233
|
+
*/
|
|
234
|
+
preference_set?: PreferencesAPI.PreferenceSetRequest | null;
|
|
235
|
+
}
|
|
236
|
+
namespace Settings {
|
|
237
|
+
/**
|
|
238
|
+
* The branding for the tenant.
|
|
239
|
+
*/
|
|
240
|
+
interface Branding {
|
|
241
|
+
/**
|
|
242
|
+
* The icon URL for the tenant. Must point to a valid image with an image MIME
|
|
243
|
+
* type.
|
|
244
|
+
*/
|
|
245
|
+
icon_url?: string | null;
|
|
246
|
+
/**
|
|
247
|
+
* The logo URL for the tenant. Must point to a valid image with an image MIME
|
|
248
|
+
* type.
|
|
249
|
+
*/
|
|
250
|
+
logo_url?: string | null;
|
|
251
|
+
/**
|
|
252
|
+
* The primary color for the tenant, provided as a hex value.
|
|
253
|
+
*/
|
|
254
|
+
primary_color?: string | null;
|
|
255
|
+
/**
|
|
256
|
+
* The primary color contrast for the tenant, provided as a hex value.
|
|
257
|
+
*/
|
|
258
|
+
primary_color_contrast?: string | null;
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
export declare namespace Tenants {
|
|
263
|
+
export { type InlineTenantRequest as InlineTenantRequest, type Tenant as Tenant, type TenantRequest as TenantRequest, type TenantDeleteResponse as TenantDeleteResponse, type TenantsEntriesCursor as TenantsEntriesCursor, type TenantListParams as TenantListParams, type TenantSetParams as TenantSetParams, };
|
|
264
|
+
export { Bulk as Bulk, type BulkDeleteParams as BulkDeleteParams, type BulkSetParams as BulkSetParams };
|
|
265
|
+
}
|
|
266
|
+
//# sourceMappingURL=tenants.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}
|
|
@@ -0,0 +1,77 @@
|
|
|
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.Tenants = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const BulkAPI = tslib_1.__importStar(require("./bulk.js"));
|
|
8
|
+
const bulk_1 = require("./bulk.js");
|
|
9
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
10
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
11
|
+
class Tenants extends resource_1.APIResource {
|
|
12
|
+
constructor() {
|
|
13
|
+
super(...arguments);
|
|
14
|
+
this.bulk = new BulkAPI.Bulk(this._client);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* List tenants for the current environment.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* // Automatically fetches more pages as needed.
|
|
22
|
+
* for await (const tenant of client.tenants.list()) {
|
|
23
|
+
* // ...
|
|
24
|
+
* }
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
list(query = {}, options) {
|
|
28
|
+
return this._client.getAPIList('/v1/tenants', (pagination_1.EntriesCursor), { query, ...options });
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const tenant = await client.tenants.delete('id');
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
delete(id, options) {
|
|
39
|
+
return this._client.delete((0, path_1.path) `/v1/tenants/${id}`, options);
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Get a tenant by ID.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const tenant = await client.tenants.get('id');
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
get(id, options) {
|
|
50
|
+
return this._client.get((0, path_1.path) `/v1/tenants/${id}`, options);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
54
|
+
* existing properties will be merged with the incoming properties.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* const tenant = await client.tenants.set('id', {
|
|
59
|
+
* settings: {
|
|
60
|
+
* branding: {
|
|
61
|
+
* icon_url:
|
|
62
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
63
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
64
|
+
* primary_color: '#DF1A22',
|
|
65
|
+
* primary_color_contrast: '#FFDE00',
|
|
66
|
+
* },
|
|
67
|
+
* },
|
|
68
|
+
* });
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
set(id, body, options) {
|
|
72
|
+
return this._client.put((0, path_1.path) `/v1/tenants/${id}`, { body, ...options });
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
exports.Tenants = Tenants;
|
|
76
|
+
Tenants.Bulk = bulk_1.Bulk;
|
|
77
|
+
//# sourceMappingURL=tenants.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,2DAAkC;AAClC,oCAA+D;AAE/D,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkEtD,CAAC;IAhEC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,0BAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAnED,0BAmEC;AA+OD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as BulkAPI from "./bulk.mjs";
|
|
4
|
+
import { Bulk } from "./bulk.mjs";
|
|
5
|
+
import { EntriesCursor } from "../../core/pagination.mjs";
|
|
6
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
7
|
+
export class Tenants extends APIResource {
|
|
8
|
+
constructor() {
|
|
9
|
+
super(...arguments);
|
|
10
|
+
this.bulk = new BulkAPI.Bulk(this._client);
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* List tenants for the current environment.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* // Automatically fetches more pages as needed.
|
|
18
|
+
* for await (const tenant of client.tenants.list()) {
|
|
19
|
+
* // ...
|
|
20
|
+
* }
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
list(query = {}, options) {
|
|
24
|
+
return this._client.getAPIList('/v1/tenants', (EntriesCursor), { query, ...options });
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const tenant = await client.tenants.delete('id');
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
delete(id, options) {
|
|
35
|
+
return this._client.delete(path `/v1/tenants/${id}`, options);
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Get a tenant by ID.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const tenant = await client.tenants.get('id');
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
get(id, options) {
|
|
46
|
+
return this._client.get(path `/v1/tenants/${id}`, options);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
50
|
+
* existing properties will be merged with the incoming properties.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const tenant = await client.tenants.set('id', {
|
|
55
|
+
* settings: {
|
|
56
|
+
* branding: {
|
|
57
|
+
* icon_url:
|
|
58
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
59
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
60
|
+
* primary_color: '#DF1A22',
|
|
61
|
+
* primary_color_contrast: '#FFDE00',
|
|
62
|
+
* },
|
|
63
|
+
* },
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
set(id, body, options) {
|
|
68
|
+
return this._client.put(path `/v1/tenants/${id}`, { body, ...options });
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
Tenants.Bulk = Bulk;
|
|
72
|
+
//# sourceMappingURL=tenants.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAmC;OAEzC,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkEtD,CAAC;IAhEC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,aAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA+OD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,6 @@
|
|
|
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
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./tenants/index.js"), exports);
|
|
6
|
+
//# sourceMappingURL=tenants.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6DAAgC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as BulkOperationsAPI from "../bulk-operations.mjs";
|
|
3
|
+
import * as PreferencesAPI from "../recipients/preferences.mjs";
|
|
4
|
+
import * as UsersAPI from "./users.mjs";
|
|
5
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
export declare class Bulk extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Deletes multiple users in a single operation. Accepts up to 100 user IDs to
|
|
10
|
+
* delete and returns a bulk operation that can be queried for progress.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const bulkOperation = await client.users.bulk.delete({
|
|
15
|
+
* user_ids: ['user_1', 'user_2'],
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
20
|
+
/**
|
|
21
|
+
* Identifies multiple users in a single operation. Allows creating or updating up
|
|
22
|
+
* to 100 users in a single batch with various properties, preferences, and channel
|
|
23
|
+
* data.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const bulkOperation = await client.users.bulk.identify({
|
|
28
|
+
* users: [
|
|
29
|
+
* {
|
|
30
|
+
* email: 'jane@ingen.net',
|
|
31
|
+
* id: 'user_1',
|
|
32
|
+
* name: 'Jane Doe',
|
|
33
|
+
* timezone: 'America/New_York',
|
|
34
|
+
* },
|
|
35
|
+
* ],
|
|
36
|
+
* });
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
40
|
+
/**
|
|
41
|
+
* Sets preferences for multiple users in a single operation. Supports either
|
|
42
|
+
* setting the same preferences for multiple users or specific preferences for each
|
|
43
|
+
* user.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const bulkOperation =
|
|
48
|
+
* await client.users.bulk.setPreferences({
|
|
49
|
+
* preferences: {
|
|
50
|
+
* categories: {
|
|
51
|
+
* marketing: false,
|
|
52
|
+
* transactional: { channel_types: { email: false } },
|
|
53
|
+
* },
|
|
54
|
+
* channel_types: { email: true },
|
|
55
|
+
* workflows: {
|
|
56
|
+
* 'dinosaurs-loose': {
|
|
57
|
+
* channel_types: { email: false },
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* },
|
|
61
|
+
* user_ids: ['user_1', 'user_2'],
|
|
62
|
+
* });
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
setPreferences(body: BulkSetPreferencesParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
66
|
+
}
|
|
67
|
+
export interface BulkDeleteParams {
|
|
68
|
+
/**
|
|
69
|
+
* A list of user IDs.
|
|
70
|
+
*/
|
|
71
|
+
user_ids: Array<string>;
|
|
72
|
+
}
|
|
73
|
+
export interface BulkIdentifyParams {
|
|
74
|
+
/**
|
|
75
|
+
* A list of users.
|
|
76
|
+
*/
|
|
77
|
+
users: Array<UsersAPI.InlineIdentifyUserRequest>;
|
|
78
|
+
}
|
|
79
|
+
export interface BulkSetPreferencesParams {
|
|
80
|
+
/**
|
|
81
|
+
* A request to set a preference set for a recipient.
|
|
82
|
+
*/
|
|
83
|
+
preferences: PreferencesAPI.PreferenceSetRequest;
|
|
84
|
+
/**
|
|
85
|
+
* A list of user IDs.
|
|
86
|
+
*/
|
|
87
|
+
user_ids: Array<string>;
|
|
88
|
+
}
|
|
89
|
+
export declare namespace Bulk {
|
|
90
|
+
export { type BulkDeleteParams as BulkDeleteParams, type BulkIdentifyParams as BulkIdentifyParams, type BulkSetPreferencesParams as BulkSetPreferencesParams, };
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=bulk.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as BulkOperationsAPI from "../bulk-operations.js";
|
|
3
|
+
import * as PreferencesAPI from "../recipients/preferences.js";
|
|
4
|
+
import * as UsersAPI from "./users.js";
|
|
5
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
7
|
+
export declare class Bulk extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Deletes multiple users in a single operation. Accepts up to 100 user IDs to
|
|
10
|
+
* delete and returns a bulk operation that can be queried for progress.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const bulkOperation = await client.users.bulk.delete({
|
|
15
|
+
* user_ids: ['user_1', 'user_2'],
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
20
|
+
/**
|
|
21
|
+
* Identifies multiple users in a single operation. Allows creating or updating up
|
|
22
|
+
* to 100 users in a single batch with various properties, preferences, and channel
|
|
23
|
+
* data.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const bulkOperation = await client.users.bulk.identify({
|
|
28
|
+
* users: [
|
|
29
|
+
* {
|
|
30
|
+
* email: 'jane@ingen.net',
|
|
31
|
+
* id: 'user_1',
|
|
32
|
+
* name: 'Jane Doe',
|
|
33
|
+
* timezone: 'America/New_York',
|
|
34
|
+
* },
|
|
35
|
+
* ],
|
|
36
|
+
* });
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
40
|
+
/**
|
|
41
|
+
* Sets preferences for multiple users in a single operation. Supports either
|
|
42
|
+
* setting the same preferences for multiple users or specific preferences for each
|
|
43
|
+
* user.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const bulkOperation =
|
|
48
|
+
* await client.users.bulk.setPreferences({
|
|
49
|
+
* preferences: {
|
|
50
|
+
* categories: {
|
|
51
|
+
* marketing: false,
|
|
52
|
+
* transactional: { channel_types: { email: false } },
|
|
53
|
+
* },
|
|
54
|
+
* channel_types: { email: true },
|
|
55
|
+
* workflows: {
|
|
56
|
+
* 'dinosaurs-loose': {
|
|
57
|
+
* channel_types: { email: false },
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* },
|
|
61
|
+
* user_ids: ['user_1', 'user_2'],
|
|
62
|
+
* });
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
setPreferences(body: BulkSetPreferencesParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
66
|
+
}
|
|
67
|
+
export interface BulkDeleteParams {
|
|
68
|
+
/**
|
|
69
|
+
* A list of user IDs.
|
|
70
|
+
*/
|
|
71
|
+
user_ids: Array<string>;
|
|
72
|
+
}
|
|
73
|
+
export interface BulkIdentifyParams {
|
|
74
|
+
/**
|
|
75
|
+
* A list of users.
|
|
76
|
+
*/
|
|
77
|
+
users: Array<UsersAPI.InlineIdentifyUserRequest>;
|
|
78
|
+
}
|
|
79
|
+
export interface BulkSetPreferencesParams {
|
|
80
|
+
/**
|
|
81
|
+
* A request to set a preference set for a recipient.
|
|
82
|
+
*/
|
|
83
|
+
preferences: PreferencesAPI.PreferenceSetRequest;
|
|
84
|
+
/**
|
|
85
|
+
* A list of user IDs.
|
|
86
|
+
*/
|
|
87
|
+
user_ids: Array<string>;
|
|
88
|
+
}
|
|
89
|
+
export declare namespace Bulk {
|
|
90
|
+
export { type BulkDeleteParams as BulkDeleteParams, type BulkIdentifyParams as BulkIdentifyParams, type BulkSetPreferencesParams as BulkSetPreferencesParams, };
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=bulk.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|