@notiflows/node 0.0.1
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/LICENSE +201 -0
- package/README.md +422 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +207 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +207 -0
- package/client.d.ts.map +1 -0
- package/client.js +502 -0
- package/client.js.map +1 -0
- package/client.mjs +498 -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 +59 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +59 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -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 +40 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +37 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +87 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +81 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +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/package.json +147 -0
- 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/deliveries.d.mts +143 -0
- package/resources/deliveries.d.mts.map +1 -0
- package/resources/deliveries.d.ts +143 -0
- package/resources/deliveries.d.ts.map +1 -0
- package/resources/deliveries.js +44 -0
- package/resources/deliveries.js.map +1 -0
- package/resources/deliveries.mjs +40 -0
- package/resources/deliveries.mjs.map +1 -0
- package/resources/index.d.mts +6 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +6 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +15 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +7 -0
- package/resources/index.mjs.map +1 -0
- package/resources/notifications.d.mts +170 -0
- package/resources/notifications.d.mts.map +1 -0
- package/resources/notifications.d.ts +170 -0
- package/resources/notifications.d.ts.map +1 -0
- package/resources/notifications.js +58 -0
- package/resources/notifications.js.map +1 -0
- package/resources/notifications.mjs +54 -0
- package/resources/notifications.mjs.map +1 -0
- package/resources/notiflows.d.mts +122 -0
- package/resources/notiflows.d.mts.map +1 -0
- package/resources/notiflows.d.ts +122 -0
- package/resources/notiflows.d.ts.map +1 -0
- package/resources/notiflows.js +36 -0
- package/resources/notiflows.js.map +1 -0
- package/resources/notiflows.mjs +32 -0
- package/resources/notiflows.mjs.map +1 -0
- package/resources/topics/index.d.mts +3 -0
- package/resources/topics/index.d.mts.map +1 -0
- package/resources/topics/index.d.ts +3 -0
- package/resources/topics/index.d.ts.map +1 -0
- package/resources/topics/index.js +9 -0
- package/resources/topics/index.js.map +1 -0
- package/resources/topics/index.mjs +4 -0
- package/resources/topics/index.mjs.map +1 -0
- package/resources/topics/subscriptions.d.mts +137 -0
- package/resources/topics/subscriptions.d.mts.map +1 -0
- package/resources/topics/subscriptions.d.ts +137 -0
- package/resources/topics/subscriptions.d.ts.map +1 -0
- package/resources/topics/subscriptions.js +78 -0
- package/resources/topics/subscriptions.js.map +1 -0
- package/resources/topics/subscriptions.mjs +74 -0
- package/resources/topics/subscriptions.mjs.map +1 -0
- package/resources/topics/topics.d.mts +70 -0
- package/resources/topics/topics.d.mts.map +1 -0
- package/resources/topics/topics.d.ts +70 -0
- package/resources/topics/topics.d.ts.map +1 -0
- package/resources/topics/topics.js +65 -0
- package/resources/topics/topics.js.map +1 -0
- package/resources/topics/topics.mjs +60 -0
- package/resources/topics/topics.mjs.map +1 -0
- package/resources/topics.d.mts +2 -0
- package/resources/topics.d.mts.map +1 -0
- package/resources/topics.d.ts +2 -0
- package/resources/topics.d.ts.map +1 -0
- package/resources/topics.js +6 -0
- package/resources/topics.js.map +1 -0
- package/resources/topics.mjs +3 -0
- package/resources/topics.mjs.map +1 -0
- package/resources/users/channel-settings.d.mts +158 -0
- package/resources/users/channel-settings.d.mts.map +1 -0
- package/resources/users/channel-settings.d.ts +158 -0
- package/resources/users/channel-settings.d.ts.map +1 -0
- package/resources/users/channel-settings.js +98 -0
- package/resources/users/channel-settings.js.map +1 -0
- package/resources/users/channel-settings.mjs +94 -0
- package/resources/users/channel-settings.mjs.map +1 -0
- package/resources/users/deliveries.d.mts +71 -0
- package/resources/users/deliveries.d.mts.map +1 -0
- package/resources/users/deliveries.d.ts +71 -0
- package/resources/users/deliveries.d.ts.map +1 -0
- package/resources/users/deliveries.js +45 -0
- package/resources/users/deliveries.js.map +1 -0
- package/resources/users/deliveries.mjs +41 -0
- package/resources/users/deliveries.mjs.map +1 -0
- package/resources/users/index.d.mts +7 -0
- package/resources/users/index.d.mts.map +1 -0
- package/resources/users/index.d.ts +7 -0
- package/resources/users/index.d.ts.map +1 -0
- package/resources/users/index.js +17 -0
- package/resources/users/index.js.map +1 -0
- package/resources/users/index.mjs +8 -0
- package/resources/users/index.mjs.map +1 -0
- package/resources/users/notifications.d.mts +68 -0
- package/resources/users/notifications.d.mts.map +1 -0
- package/resources/users/notifications.d.ts +68 -0
- package/resources/users/notifications.d.ts.map +1 -0
- package/resources/users/notifications.js +43 -0
- package/resources/users/notifications.js.map +1 -0
- package/resources/users/notifications.mjs +39 -0
- package/resources/users/notifications.mjs.map +1 -0
- package/resources/users/preferences.d.mts +166 -0
- package/resources/users/preferences.d.mts.map +1 -0
- package/resources/users/preferences.d.ts +166 -0
- package/resources/users/preferences.d.ts.map +1 -0
- package/resources/users/preferences.js +60 -0
- package/resources/users/preferences.js.map +1 -0
- package/resources/users/preferences.mjs +56 -0
- package/resources/users/preferences.mjs.map +1 -0
- package/resources/users/subscriptions.d.mts +121 -0
- package/resources/users/subscriptions.d.mts.map +1 -0
- package/resources/users/subscriptions.d.ts +121 -0
- package/resources/users/subscriptions.d.ts.map +1 -0
- package/resources/users/subscriptions.js +84 -0
- package/resources/users/subscriptions.js.map +1 -0
- package/resources/users/subscriptions.mjs +80 -0
- package/resources/users/subscriptions.mjs.map +1 -0
- package/resources/users/users.d.mts +216 -0
- package/resources/users/users.d.mts.map +1 -0
- package/resources/users/users.d.ts +216 -0
- package/resources/users/users.d.ts.map +1 -0
- package/resources/users/users.js +102 -0
- package/resources/users/users.js.map +1 -0
- package/resources/users/users.mjs +97 -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.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 +838 -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 +163 -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 +56 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +128 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/pagination.ts +2 -0
- package/src/resource.ts +2 -0
- package/src/resources/deliveries.ts +183 -0
- package/src/resources/index.ts +19 -0
- package/src/resources/notifications.ts +225 -0
- package/src/resources/notiflows.ts +155 -0
- package/src/resources/topics/index.ts +11 -0
- package/src/resources/topics/subscriptions.ts +182 -0
- package/src/resources/topics/topics.ts +115 -0
- package/src/resources/topics.ts +3 -0
- package/src/resources/users/channel-settings.ts +205 -0
- package/src/resources/users/deliveries.ts +103 -0
- package/src/resources/users/index.ts +23 -0
- package/src/resources/users/notifications.ts +100 -0
- package/src/resources/users/preferences.ts +182 -0
- package/src/resources/users/subscriptions.ts +179 -0
- package/src/resources/users/users.ts +324 -0
- package/src/resources/users.ts +3 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as SubscriptionsAPI from "./subscriptions.mjs";
|
|
4
|
+
import { Subscriptions, } from "./subscriptions.mjs";
|
|
5
|
+
import { CursorPage } from "../../core/pagination.mjs";
|
|
6
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
7
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
8
|
+
export class Topics extends APIResource {
|
|
9
|
+
constructor() {
|
|
10
|
+
super(...arguments);
|
|
11
|
+
this.subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Retrieve a topic by name.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const topic = await client.topics.retrieve('order-updates');
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
retrieve(id, options) {
|
|
22
|
+
return this._client.get(path `/topics/${id}`, options);
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Retrieve a paginated list of all topics in your project.
|
|
26
|
+
*
|
|
27
|
+
* Topics are used for pub/sub notification patterns. Users subscribe to topics,
|
|
28
|
+
* and you can run notiflows for all subscribers of a topic.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* // Automatically fetches more pages as needed.
|
|
33
|
+
* for await (const topic of client.topics.list()) {
|
|
34
|
+
* // ...
|
|
35
|
+
* }
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
list(query = {}, options) {
|
|
39
|
+
return this._client.getAPIList('/topics', (CursorPage), { query, ...options });
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Delete a topic and all its subscriptions.
|
|
43
|
+
*
|
|
44
|
+
* **Warning:** This removes all user subscriptions to this topic. Users will need
|
|
45
|
+
* to re-subscribe if the topic is recreated.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* await client.topics.delete('order-updates');
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
delete(id, options) {
|
|
53
|
+
return this._client.delete(path `/topics/${id}`, {
|
|
54
|
+
...options,
|
|
55
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
Topics.Subscriptions = Subscriptions;
|
|
60
|
+
//# sourceMappingURL=topics.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"topics.mjs","sourceRoot":"","sources":["../../src/resources/topics/topics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAML,aAAa,GACd;OAEM,EAAE,UAAU,EAAsC;OAClD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoDnG,CAAC;IAlDC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,UAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA0BD,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"topics.d.mts","sourceRoot":"","sources":["../src/resources/topics.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../src/resources/topics.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("./topics/index.js"), exports);
|
|
6
|
+
//# sourceMappingURL=topics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"topics.js","sourceRoot":"","sources":["../src/resources/topics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAA+B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"topics.mjs","sourceRoot":"","sources":["../src/resources/topics.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
export declare class ChannelSettings extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Retrieve a user's settings for a specific channel.
|
|
7
|
+
*
|
|
8
|
+
* Channel settings store provider-specific data like device tokens (for push) or
|
|
9
|
+
* Slack user IDs (for chat).
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const channelSettings =
|
|
14
|
+
* await client.users.channelSettings.retrieve(
|
|
15
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
16
|
+
* { user_id: 'user_12345' },
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
retrieve(channelID: string, params: ChannelSettingRetrieveParams, options?: RequestOptions): APIPromise<ChannelSettings>;
|
|
21
|
+
/**
|
|
22
|
+
* Update a user's settings for a specific channel. Creates the settings if they
|
|
23
|
+
* don't exist.
|
|
24
|
+
*
|
|
25
|
+
* **Provider-specific settings:**
|
|
26
|
+
*
|
|
27
|
+
* **Mobile Push (APNS/FCM):**
|
|
28
|
+
*
|
|
29
|
+
* ```json
|
|
30
|
+
* {
|
|
31
|
+
* "settings": {
|
|
32
|
+
* "device_tokens": ["token1", "token2"]
|
|
33
|
+
* }
|
|
34
|
+
* }
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* **Slack:**
|
|
38
|
+
*
|
|
39
|
+
* ```json
|
|
40
|
+
* {
|
|
41
|
+
* "settings": {
|
|
42
|
+
* "slack_channel_id": "C0123456789",
|
|
43
|
+
* "slack_user_id": "U0123456789"
|
|
44
|
+
* }
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* At least one of `slack_channel_id` or `slack_user_id` must be provided.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const channelSettings =
|
|
53
|
+
* await client.users.channelSettings.update(
|
|
54
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
55
|
+
* {
|
|
56
|
+
* user_id: 'user_12345',
|
|
57
|
+
* settings: {
|
|
58
|
+
* device_tokens: ['ExampleTokenABCDEF123456789...'],
|
|
59
|
+
* },
|
|
60
|
+
* },
|
|
61
|
+
* );
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
update(channelID: string, params: ChannelSettingUpdateParams, options?: RequestOptions): APIPromise<ChannelSettings>;
|
|
65
|
+
/**
|
|
66
|
+
* Remove a user's settings for a specific channel.
|
|
67
|
+
*
|
|
68
|
+
* After deletion, the user will no longer receive notifications through this
|
|
69
|
+
* channel until new settings are configured.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* await client.users.channelSettings.delete(
|
|
74
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
75
|
+
* { user_id: 'user_12345' },
|
|
76
|
+
* );
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
delete(channelID: string, params: ChannelSettingDeleteParams, options?: RequestOptions): APIPromise<void>;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* User's settings for a specific channel (e.g., device tokens, Slack credentials)
|
|
83
|
+
*/
|
|
84
|
+
export interface ChannelSettings {
|
|
85
|
+
/**
|
|
86
|
+
* Channel ID
|
|
87
|
+
*/
|
|
88
|
+
channel_id: string;
|
|
89
|
+
/**
|
|
90
|
+
* When the settings were created
|
|
91
|
+
*/
|
|
92
|
+
created_at: string;
|
|
93
|
+
/**
|
|
94
|
+
* The provider type for this channel
|
|
95
|
+
*/
|
|
96
|
+
provider: 'apns' | 'fcm' | 'slack';
|
|
97
|
+
/**
|
|
98
|
+
* Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
|
|
99
|
+
*/
|
|
100
|
+
settings: MobilePushSettings | SlackSettings;
|
|
101
|
+
/**
|
|
102
|
+
* When the settings were last updated
|
|
103
|
+
*/
|
|
104
|
+
updated_at: string;
|
|
105
|
+
/**
|
|
106
|
+
* Internal user ID
|
|
107
|
+
*/
|
|
108
|
+
user_id: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Settings for mobile push notifications (APNS/FCM)
|
|
112
|
+
*/
|
|
113
|
+
export interface MobilePushSettings {
|
|
114
|
+
/**
|
|
115
|
+
* List of device tokens for push notifications. At least one token is required.
|
|
116
|
+
*/
|
|
117
|
+
device_tokens: Array<string>;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Settings for Slack notifications. At least one of `slack_channel_id` or
|
|
121
|
+
* `slack_user_id` must be provided.
|
|
122
|
+
*/
|
|
123
|
+
export interface SlackSettings {
|
|
124
|
+
/**
|
|
125
|
+
* Slack channel ID (starts with C)
|
|
126
|
+
*/
|
|
127
|
+
slack_channel_id?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Slack user ID for direct messages (starts with U)
|
|
130
|
+
*/
|
|
131
|
+
slack_user_id?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface ChannelSettingRetrieveParams {
|
|
134
|
+
/**
|
|
135
|
+
* User external ID
|
|
136
|
+
*/
|
|
137
|
+
user_id: string;
|
|
138
|
+
}
|
|
139
|
+
export interface ChannelSettingUpdateParams {
|
|
140
|
+
/**
|
|
141
|
+
* Path param: User external ID
|
|
142
|
+
*/
|
|
143
|
+
user_id: string;
|
|
144
|
+
/**
|
|
145
|
+
* Body param: Provider-specific settings. Structure depends on channel provider.
|
|
146
|
+
*/
|
|
147
|
+
settings: MobilePushSettings | SlackSettings;
|
|
148
|
+
}
|
|
149
|
+
export interface ChannelSettingDeleteParams {
|
|
150
|
+
/**
|
|
151
|
+
* User external ID
|
|
152
|
+
*/
|
|
153
|
+
user_id: string;
|
|
154
|
+
}
|
|
155
|
+
export declare namespace ChannelSettings {
|
|
156
|
+
export { type ChannelSettings as ChannelSettings, type MobilePushSettings as MobilePushSettings, type SlackSettings as SlackSettings, type ChannelSettingRetrieveParams as ChannelSettingRetrieveParams, type ChannelSettingUpdateParams as ChannelSettingUpdateParams, type ChannelSettingDeleteParams as ChannelSettingDeleteParams, };
|
|
157
|
+
}
|
|
158
|
+
//# sourceMappingURL=channel-settings.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"channel-settings.d.mts","sourceRoot":"","sources":["../../src/resources/users/channel-settings.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAK9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAK9B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1G;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,aAAa,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,aAAa,CAAC;CAC9C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
export declare class ChannelSettings extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Retrieve a user's settings for a specific channel.
|
|
7
|
+
*
|
|
8
|
+
* Channel settings store provider-specific data like device tokens (for push) or
|
|
9
|
+
* Slack user IDs (for chat).
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const channelSettings =
|
|
14
|
+
* await client.users.channelSettings.retrieve(
|
|
15
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
16
|
+
* { user_id: 'user_12345' },
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
retrieve(channelID: string, params: ChannelSettingRetrieveParams, options?: RequestOptions): APIPromise<ChannelSettings>;
|
|
21
|
+
/**
|
|
22
|
+
* Update a user's settings for a specific channel. Creates the settings if they
|
|
23
|
+
* don't exist.
|
|
24
|
+
*
|
|
25
|
+
* **Provider-specific settings:**
|
|
26
|
+
*
|
|
27
|
+
* **Mobile Push (APNS/FCM):**
|
|
28
|
+
*
|
|
29
|
+
* ```json
|
|
30
|
+
* {
|
|
31
|
+
* "settings": {
|
|
32
|
+
* "device_tokens": ["token1", "token2"]
|
|
33
|
+
* }
|
|
34
|
+
* }
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* **Slack:**
|
|
38
|
+
*
|
|
39
|
+
* ```json
|
|
40
|
+
* {
|
|
41
|
+
* "settings": {
|
|
42
|
+
* "slack_channel_id": "C0123456789",
|
|
43
|
+
* "slack_user_id": "U0123456789"
|
|
44
|
+
* }
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* At least one of `slack_channel_id` or `slack_user_id` must be provided.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const channelSettings =
|
|
53
|
+
* await client.users.channelSettings.update(
|
|
54
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
55
|
+
* {
|
|
56
|
+
* user_id: 'user_12345',
|
|
57
|
+
* settings: {
|
|
58
|
+
* device_tokens: ['ExampleTokenABCDEF123456789...'],
|
|
59
|
+
* },
|
|
60
|
+
* },
|
|
61
|
+
* );
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
update(channelID: string, params: ChannelSettingUpdateParams, options?: RequestOptions): APIPromise<ChannelSettings>;
|
|
65
|
+
/**
|
|
66
|
+
* Remove a user's settings for a specific channel.
|
|
67
|
+
*
|
|
68
|
+
* After deletion, the user will no longer receive notifications through this
|
|
69
|
+
* channel until new settings are configured.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* await client.users.channelSettings.delete(
|
|
74
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
75
|
+
* { user_id: 'user_12345' },
|
|
76
|
+
* );
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
delete(channelID: string, params: ChannelSettingDeleteParams, options?: RequestOptions): APIPromise<void>;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* User's settings for a specific channel (e.g., device tokens, Slack credentials)
|
|
83
|
+
*/
|
|
84
|
+
export interface ChannelSettings {
|
|
85
|
+
/**
|
|
86
|
+
* Channel ID
|
|
87
|
+
*/
|
|
88
|
+
channel_id: string;
|
|
89
|
+
/**
|
|
90
|
+
* When the settings were created
|
|
91
|
+
*/
|
|
92
|
+
created_at: string;
|
|
93
|
+
/**
|
|
94
|
+
* The provider type for this channel
|
|
95
|
+
*/
|
|
96
|
+
provider: 'apns' | 'fcm' | 'slack';
|
|
97
|
+
/**
|
|
98
|
+
* Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
|
|
99
|
+
*/
|
|
100
|
+
settings: MobilePushSettings | SlackSettings;
|
|
101
|
+
/**
|
|
102
|
+
* When the settings were last updated
|
|
103
|
+
*/
|
|
104
|
+
updated_at: string;
|
|
105
|
+
/**
|
|
106
|
+
* Internal user ID
|
|
107
|
+
*/
|
|
108
|
+
user_id: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Settings for mobile push notifications (APNS/FCM)
|
|
112
|
+
*/
|
|
113
|
+
export interface MobilePushSettings {
|
|
114
|
+
/**
|
|
115
|
+
* List of device tokens for push notifications. At least one token is required.
|
|
116
|
+
*/
|
|
117
|
+
device_tokens: Array<string>;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Settings for Slack notifications. At least one of `slack_channel_id` or
|
|
121
|
+
* `slack_user_id` must be provided.
|
|
122
|
+
*/
|
|
123
|
+
export interface SlackSettings {
|
|
124
|
+
/**
|
|
125
|
+
* Slack channel ID (starts with C)
|
|
126
|
+
*/
|
|
127
|
+
slack_channel_id?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Slack user ID for direct messages (starts with U)
|
|
130
|
+
*/
|
|
131
|
+
slack_user_id?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface ChannelSettingRetrieveParams {
|
|
134
|
+
/**
|
|
135
|
+
* User external ID
|
|
136
|
+
*/
|
|
137
|
+
user_id: string;
|
|
138
|
+
}
|
|
139
|
+
export interface ChannelSettingUpdateParams {
|
|
140
|
+
/**
|
|
141
|
+
* Path param: User external ID
|
|
142
|
+
*/
|
|
143
|
+
user_id: string;
|
|
144
|
+
/**
|
|
145
|
+
* Body param: Provider-specific settings. Structure depends on channel provider.
|
|
146
|
+
*/
|
|
147
|
+
settings: MobilePushSettings | SlackSettings;
|
|
148
|
+
}
|
|
149
|
+
export interface ChannelSettingDeleteParams {
|
|
150
|
+
/**
|
|
151
|
+
* User external ID
|
|
152
|
+
*/
|
|
153
|
+
user_id: string;
|
|
154
|
+
}
|
|
155
|
+
export declare namespace ChannelSettings {
|
|
156
|
+
export { type ChannelSettings as ChannelSettings, type MobilePushSettings as MobilePushSettings, type SlackSettings as SlackSettings, type ChannelSettingRetrieveParams as ChannelSettingRetrieveParams, type ChannelSettingUpdateParams as ChannelSettingUpdateParams, type ChannelSettingDeleteParams as ChannelSettingDeleteParams, };
|
|
157
|
+
}
|
|
158
|
+
//# sourceMappingURL=channel-settings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"channel-settings.d.ts","sourceRoot":"","sources":["../../src/resources/users/channel-settings.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAK9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAK9B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1G;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,aAAa,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,aAAa,CAAC;CAC9C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|
|
@@ -0,0 +1,98 @@
|
|
|
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.ChannelSettings = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const headers_1 = require("../../internal/headers.js");
|
|
7
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
8
|
+
class ChannelSettings extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve a user's settings for a specific channel.
|
|
11
|
+
*
|
|
12
|
+
* Channel settings store provider-specific data like device tokens (for push) or
|
|
13
|
+
* Slack user IDs (for chat).
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const channelSettings =
|
|
18
|
+
* await client.users.channelSettings.retrieve(
|
|
19
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
20
|
+
* { user_id: 'user_12345' },
|
|
21
|
+
* );
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
retrieve(channelID, params, options) {
|
|
25
|
+
const { user_id } = params;
|
|
26
|
+
return this._client.get((0, path_1.path) `/users/${user_id}/channel-settings/${channelID}`, options);
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Update a user's settings for a specific channel. Creates the settings if they
|
|
30
|
+
* don't exist.
|
|
31
|
+
*
|
|
32
|
+
* **Provider-specific settings:**
|
|
33
|
+
*
|
|
34
|
+
* **Mobile Push (APNS/FCM):**
|
|
35
|
+
*
|
|
36
|
+
* ```json
|
|
37
|
+
* {
|
|
38
|
+
* "settings": {
|
|
39
|
+
* "device_tokens": ["token1", "token2"]
|
|
40
|
+
* }
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
44
|
+
* **Slack:**
|
|
45
|
+
*
|
|
46
|
+
* ```json
|
|
47
|
+
* {
|
|
48
|
+
* "settings": {
|
|
49
|
+
* "slack_channel_id": "C0123456789",
|
|
50
|
+
* "slack_user_id": "U0123456789"
|
|
51
|
+
* }
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* At least one of `slack_channel_id` or `slack_user_id` must be provided.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const channelSettings =
|
|
60
|
+
* await client.users.channelSettings.update(
|
|
61
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
62
|
+
* {
|
|
63
|
+
* user_id: 'user_12345',
|
|
64
|
+
* settings: {
|
|
65
|
+
* device_tokens: ['ExampleTokenABCDEF123456789...'],
|
|
66
|
+
* },
|
|
67
|
+
* },
|
|
68
|
+
* );
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
update(channelID, params, options) {
|
|
72
|
+
const { user_id, ...body } = params;
|
|
73
|
+
return this._client.put((0, path_1.path) `/users/${user_id}/channel-settings/${channelID}`, { body, ...options });
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Remove a user's settings for a specific channel.
|
|
77
|
+
*
|
|
78
|
+
* After deletion, the user will no longer receive notifications through this
|
|
79
|
+
* channel until new settings are configured.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* await client.users.channelSettings.delete(
|
|
84
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
85
|
+
* { user_id: 'user_12345' },
|
|
86
|
+
* );
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
delete(channelID, params, options) {
|
|
90
|
+
const { user_id } = params;
|
|
91
|
+
return this._client.delete((0, path_1.path) `/users/${user_id}/channel-settings/${channelID}`, {
|
|
92
|
+
...options,
|
|
93
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
exports.ChannelSettings = ChannelSettings;
|
|
98
|
+
//# sourceMappingURL=channel-settings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"channel-settings.js","sourceRoot":"","sources":["../../src/resources/users/channel-settings.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,SAAiB,EACjB,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,qBAAqB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,qBAAqB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAiB,EAAE,MAAkC,EAAE,OAAwB;QACpF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,qBAAqB,SAAS,EAAE,EAAE;YAChF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAlGD,0CAkGC"}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
5
|
+
export class ChannelSettings extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve a user's settings for a specific channel.
|
|
8
|
+
*
|
|
9
|
+
* Channel settings store provider-specific data like device tokens (for push) or
|
|
10
|
+
* Slack user IDs (for chat).
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const channelSettings =
|
|
15
|
+
* await client.users.channelSettings.retrieve(
|
|
16
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
17
|
+
* { user_id: 'user_12345' },
|
|
18
|
+
* );
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
retrieve(channelID, params, options) {
|
|
22
|
+
const { user_id } = params;
|
|
23
|
+
return this._client.get(path `/users/${user_id}/channel-settings/${channelID}`, options);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Update a user's settings for a specific channel. Creates the settings if they
|
|
27
|
+
* don't exist.
|
|
28
|
+
*
|
|
29
|
+
* **Provider-specific settings:**
|
|
30
|
+
*
|
|
31
|
+
* **Mobile Push (APNS/FCM):**
|
|
32
|
+
*
|
|
33
|
+
* ```json
|
|
34
|
+
* {
|
|
35
|
+
* "settings": {
|
|
36
|
+
* "device_tokens": ["token1", "token2"]
|
|
37
|
+
* }
|
|
38
|
+
* }
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* **Slack:**
|
|
42
|
+
*
|
|
43
|
+
* ```json
|
|
44
|
+
* {
|
|
45
|
+
* "settings": {
|
|
46
|
+
* "slack_channel_id": "C0123456789",
|
|
47
|
+
* "slack_user_id": "U0123456789"
|
|
48
|
+
* }
|
|
49
|
+
* }
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* At least one of `slack_channel_id` or `slack_user_id` must be provided.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* const channelSettings =
|
|
57
|
+
* await client.users.channelSettings.update(
|
|
58
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
59
|
+
* {
|
|
60
|
+
* user_id: 'user_12345',
|
|
61
|
+
* settings: {
|
|
62
|
+
* device_tokens: ['ExampleTokenABCDEF123456789...'],
|
|
63
|
+
* },
|
|
64
|
+
* },
|
|
65
|
+
* );
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
update(channelID, params, options) {
|
|
69
|
+
const { user_id, ...body } = params;
|
|
70
|
+
return this._client.put(path `/users/${user_id}/channel-settings/${channelID}`, { body, ...options });
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Remove a user's settings for a specific channel.
|
|
74
|
+
*
|
|
75
|
+
* After deletion, the user will no longer receive notifications through this
|
|
76
|
+
* channel until new settings are configured.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* await client.users.channelSettings.delete(
|
|
81
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
82
|
+
* { user_id: 'user_12345' },
|
|
83
|
+
* );
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
delete(channelID, params, options) {
|
|
87
|
+
const { user_id } = params;
|
|
88
|
+
return this._client.delete(path `/users/${user_id}/channel-settings/${channelID}`, {
|
|
89
|
+
...options,
|
|
90
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=channel-settings.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"channel-settings.mjs","sourceRoot":"","sources":["../../src/resources/users/channel-settings.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,SAAiB,EACjB,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,qBAAqB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,qBAAqB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAiB,EAAE,MAAkC,EAAE,OAAwB;QACpF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,qBAAqB,SAAS,EAAE,EAAE;YAChF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|