@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,143 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class Deliveries extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve details of a single delivery attempt.
|
|
8
|
+
*
|
|
9
|
+
* Includes the rendered content (`data`), channel information, and all timestamp
|
|
10
|
+
* tracking (sent, seen, read, clicked, archived).
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const delivery = await client.deliveries.retrieve(
|
|
15
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Delivery>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieve a paginated list of all deliveries in your project.
|
|
22
|
+
*
|
|
23
|
+
* A delivery represents a single attempt to send a notification through a specific
|
|
24
|
+
* channel. Use filters to narrow down results by channel, status, or time range.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* // Automatically fetches more pages as needed.
|
|
29
|
+
* for await (const delivery of client.deliveries.list()) {
|
|
30
|
+
* // ...
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
list(query?: DeliveryListParams | null | undefined, options?: RequestOptions): PagePromise<DeliveriesCursorPage, Delivery>;
|
|
35
|
+
}
|
|
36
|
+
export type DeliveriesCursorPage = CursorPage<Delivery>;
|
|
37
|
+
/**
|
|
38
|
+
* A single delivery attempt through a specific channel
|
|
39
|
+
*/
|
|
40
|
+
export interface Delivery {
|
|
41
|
+
/**
|
|
42
|
+
* Delivery ID
|
|
43
|
+
*/
|
|
44
|
+
id: string;
|
|
45
|
+
/**
|
|
46
|
+
* Type of channel used for this delivery
|
|
47
|
+
*/
|
|
48
|
+
channel_type: 'in_app' | 'email' | 'sms' | 'chat' | 'web_push' | 'mobile_push';
|
|
49
|
+
/**
|
|
50
|
+
* When the delivery was created
|
|
51
|
+
*/
|
|
52
|
+
created_at: string;
|
|
53
|
+
/**
|
|
54
|
+
* ID of the parent notification
|
|
55
|
+
*/
|
|
56
|
+
notification_id: string;
|
|
57
|
+
/**
|
|
58
|
+
* ID of the notiflow
|
|
59
|
+
*/
|
|
60
|
+
notiflow_id: string;
|
|
61
|
+
/**
|
|
62
|
+
* Internal ID of the recipient
|
|
63
|
+
*/
|
|
64
|
+
recipient_id: string;
|
|
65
|
+
/**
|
|
66
|
+
* Delivery status:
|
|
67
|
+
*
|
|
68
|
+
* - `pending`: Queued for sending
|
|
69
|
+
* - `sent`: Successfully sent to the provider
|
|
70
|
+
* - `failed`: Delivery failed
|
|
71
|
+
*/
|
|
72
|
+
status: 'pending' | 'sent' | 'failed';
|
|
73
|
+
/**
|
|
74
|
+
* When the delivery was last updated
|
|
75
|
+
*/
|
|
76
|
+
updated_at: string;
|
|
77
|
+
/**
|
|
78
|
+
* Internal ID of the actor
|
|
79
|
+
*/
|
|
80
|
+
actor_id?: string | null;
|
|
81
|
+
/**
|
|
82
|
+
* When the recipient archived it
|
|
83
|
+
*/
|
|
84
|
+
archived_at?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* ID of the channel used for delivery
|
|
87
|
+
*/
|
|
88
|
+
channel_id?: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* When the recipient clicked/interacted
|
|
91
|
+
*/
|
|
92
|
+
clicked_at?: string | null;
|
|
93
|
+
/**
|
|
94
|
+
* Rendered notification content (varies by channel type)
|
|
95
|
+
*/
|
|
96
|
+
data?: unknown;
|
|
97
|
+
/**
|
|
98
|
+
* When the recipient marked it as read
|
|
99
|
+
*/
|
|
100
|
+
read_at?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* When the recipient saw the notification
|
|
103
|
+
*/
|
|
104
|
+
seen_at?: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* When the delivery was sent to the provider
|
|
107
|
+
*/
|
|
108
|
+
sent_at?: string | null;
|
|
109
|
+
/**
|
|
110
|
+
* Topic name if triggered via topic
|
|
111
|
+
*/
|
|
112
|
+
topic?: string | null;
|
|
113
|
+
}
|
|
114
|
+
export interface DeliveryListParams extends CursorPageParams {
|
|
115
|
+
/**
|
|
116
|
+
* Cursor for fetching the previous page
|
|
117
|
+
*/
|
|
118
|
+
before?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Filter by channel ID (UUID)
|
|
121
|
+
*/
|
|
122
|
+
channel_id?: string;
|
|
123
|
+
/**
|
|
124
|
+
* Filter by created after (ISO 8601 datetime)
|
|
125
|
+
*/
|
|
126
|
+
created_after?: string;
|
|
127
|
+
/**
|
|
128
|
+
* Filter by created before (ISO 8601 datetime)
|
|
129
|
+
*/
|
|
130
|
+
created_before?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Filter by status (pending, sent, failed)
|
|
133
|
+
*/
|
|
134
|
+
status?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Filter by topic name
|
|
137
|
+
*/
|
|
138
|
+
topic?: string;
|
|
139
|
+
}
|
|
140
|
+
export declare namespace Deliveries {
|
|
141
|
+
export { type Delivery as Delivery, type DeliveriesCursorPage as DeliveriesCursorPage, type DeliveryListParams as DeliveryListParams, };
|
|
142
|
+
}
|
|
143
|
+
//# sourceMappingURL=deliveries.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deliveries.d.mts","sourceRoot":"","sources":["../src/resources/deliveries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,QAAQ,CAAC;CAG/C;AAED,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,QAAQ,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,aAAa,CAAC;IAE/E;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class Deliveries extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve details of a single delivery attempt.
|
|
8
|
+
*
|
|
9
|
+
* Includes the rendered content (`data`), channel information, and all timestamp
|
|
10
|
+
* tracking (sent, seen, read, clicked, archived).
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const delivery = await client.deliveries.retrieve(
|
|
15
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Delivery>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieve a paginated list of all deliveries in your project.
|
|
22
|
+
*
|
|
23
|
+
* A delivery represents a single attempt to send a notification through a specific
|
|
24
|
+
* channel. Use filters to narrow down results by channel, status, or time range.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* // Automatically fetches more pages as needed.
|
|
29
|
+
* for await (const delivery of client.deliveries.list()) {
|
|
30
|
+
* // ...
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
list(query?: DeliveryListParams | null | undefined, options?: RequestOptions): PagePromise<DeliveriesCursorPage, Delivery>;
|
|
35
|
+
}
|
|
36
|
+
export type DeliveriesCursorPage = CursorPage<Delivery>;
|
|
37
|
+
/**
|
|
38
|
+
* A single delivery attempt through a specific channel
|
|
39
|
+
*/
|
|
40
|
+
export interface Delivery {
|
|
41
|
+
/**
|
|
42
|
+
* Delivery ID
|
|
43
|
+
*/
|
|
44
|
+
id: string;
|
|
45
|
+
/**
|
|
46
|
+
* Type of channel used for this delivery
|
|
47
|
+
*/
|
|
48
|
+
channel_type: 'in_app' | 'email' | 'sms' | 'chat' | 'web_push' | 'mobile_push';
|
|
49
|
+
/**
|
|
50
|
+
* When the delivery was created
|
|
51
|
+
*/
|
|
52
|
+
created_at: string;
|
|
53
|
+
/**
|
|
54
|
+
* ID of the parent notification
|
|
55
|
+
*/
|
|
56
|
+
notification_id: string;
|
|
57
|
+
/**
|
|
58
|
+
* ID of the notiflow
|
|
59
|
+
*/
|
|
60
|
+
notiflow_id: string;
|
|
61
|
+
/**
|
|
62
|
+
* Internal ID of the recipient
|
|
63
|
+
*/
|
|
64
|
+
recipient_id: string;
|
|
65
|
+
/**
|
|
66
|
+
* Delivery status:
|
|
67
|
+
*
|
|
68
|
+
* - `pending`: Queued for sending
|
|
69
|
+
* - `sent`: Successfully sent to the provider
|
|
70
|
+
* - `failed`: Delivery failed
|
|
71
|
+
*/
|
|
72
|
+
status: 'pending' | 'sent' | 'failed';
|
|
73
|
+
/**
|
|
74
|
+
* When the delivery was last updated
|
|
75
|
+
*/
|
|
76
|
+
updated_at: string;
|
|
77
|
+
/**
|
|
78
|
+
* Internal ID of the actor
|
|
79
|
+
*/
|
|
80
|
+
actor_id?: string | null;
|
|
81
|
+
/**
|
|
82
|
+
* When the recipient archived it
|
|
83
|
+
*/
|
|
84
|
+
archived_at?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* ID of the channel used for delivery
|
|
87
|
+
*/
|
|
88
|
+
channel_id?: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* When the recipient clicked/interacted
|
|
91
|
+
*/
|
|
92
|
+
clicked_at?: string | null;
|
|
93
|
+
/**
|
|
94
|
+
* Rendered notification content (varies by channel type)
|
|
95
|
+
*/
|
|
96
|
+
data?: unknown;
|
|
97
|
+
/**
|
|
98
|
+
* When the recipient marked it as read
|
|
99
|
+
*/
|
|
100
|
+
read_at?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* When the recipient saw the notification
|
|
103
|
+
*/
|
|
104
|
+
seen_at?: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* When the delivery was sent to the provider
|
|
107
|
+
*/
|
|
108
|
+
sent_at?: string | null;
|
|
109
|
+
/**
|
|
110
|
+
* Topic name if triggered via topic
|
|
111
|
+
*/
|
|
112
|
+
topic?: string | null;
|
|
113
|
+
}
|
|
114
|
+
export interface DeliveryListParams extends CursorPageParams {
|
|
115
|
+
/**
|
|
116
|
+
* Cursor for fetching the previous page
|
|
117
|
+
*/
|
|
118
|
+
before?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Filter by channel ID (UUID)
|
|
121
|
+
*/
|
|
122
|
+
channel_id?: string;
|
|
123
|
+
/**
|
|
124
|
+
* Filter by created after (ISO 8601 datetime)
|
|
125
|
+
*/
|
|
126
|
+
created_after?: string;
|
|
127
|
+
/**
|
|
128
|
+
* Filter by created before (ISO 8601 datetime)
|
|
129
|
+
*/
|
|
130
|
+
created_before?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Filter by status (pending, sent, failed)
|
|
133
|
+
*/
|
|
134
|
+
status?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Filter by topic name
|
|
137
|
+
*/
|
|
138
|
+
topic?: string;
|
|
139
|
+
}
|
|
140
|
+
export declare namespace Deliveries {
|
|
141
|
+
export { type Delivery as Delivery, type DeliveriesCursorPage as DeliveriesCursorPage, type DeliveryListParams as DeliveryListParams, };
|
|
142
|
+
}
|
|
143
|
+
//# sourceMappingURL=deliveries.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deliveries.d.ts","sourceRoot":"","sources":["../src/resources/deliveries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,QAAQ,CAAC;CAG/C;AAED,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,QAAQ,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,aAAa,CAAC;IAE/E;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -0,0 +1,44 @@
|
|
|
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.Deliveries = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class Deliveries extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve details of a single delivery attempt.
|
|
11
|
+
*
|
|
12
|
+
* Includes the rendered content (`data`), channel information, and all timestamp
|
|
13
|
+
* tracking (sent, seen, read, clicked, archived).
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const delivery = await client.deliveries.retrieve(
|
|
18
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
19
|
+
* );
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
retrieve(id, options) {
|
|
23
|
+
return this._client.get((0, path_1.path) `/deliveries/${id}`, options);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Retrieve a paginated list of all deliveries in your project.
|
|
27
|
+
*
|
|
28
|
+
* A delivery represents a single attempt to send a notification through a specific
|
|
29
|
+
* channel. Use filters to narrow down results by channel, status, or time range.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* // Automatically fetches more pages as needed.
|
|
34
|
+
* for await (const delivery of client.deliveries.list()) {
|
|
35
|
+
* // ...
|
|
36
|
+
* }
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
list(query = {}, options) {
|
|
40
|
+
return this._client.getAPIList('/deliveries', (pagination_1.CursorPage), { query, ...options });
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
exports.Deliveries = Deliveries;
|
|
44
|
+
//# sourceMappingURL=deliveries.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deliveries.js","sourceRoot":"","sources":["../src/resources/deliveries.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAoB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF;AAtCD,gCAsCC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../core/pagination.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class Deliveries extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve details of a single delivery attempt.
|
|
8
|
+
*
|
|
9
|
+
* Includes the rendered content (`data`), channel information, and all timestamp
|
|
10
|
+
* tracking (sent, seen, read, clicked, archived).
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const delivery = await client.deliveries.retrieve(
|
|
15
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
retrieve(id, options) {
|
|
20
|
+
return this._client.get(path `/deliveries/${id}`, options);
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve a paginated list of all deliveries in your project.
|
|
24
|
+
*
|
|
25
|
+
* A delivery represents a single attempt to send a notification through a specific
|
|
26
|
+
* channel. Use filters to narrow down results by channel, status, or time range.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* // Automatically fetches more pages as needed.
|
|
31
|
+
* for await (const delivery of client.deliveries.list()) {
|
|
32
|
+
* // ...
|
|
33
|
+
* }
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
list(query = {}, options) {
|
|
37
|
+
return this._client.getAPIList('/deliveries', (CursorPage), { query, ...options });
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=deliveries.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deliveries.mjs","sourceRoot":"","sources":["../src/resources/deliveries.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAoB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { Deliveries, type Delivery, type DeliveryListParams, type DeliveriesCursorPage } from "./deliveries.mjs";
|
|
2
|
+
export { Notifications, type Notification, type NotificationListParams, type NotificationListDeliveriesParams, type NotificationsCursorPage, } from "./notifications.mjs";
|
|
3
|
+
export { NotiflowsResource, type NotiflowRunResponse, type NotiflowRunParams } from "./notiflows.mjs";
|
|
4
|
+
export { Topics, type Topic, type TopicListParams, type TopicsCursorPage } from "./topics/topics.mjs";
|
|
5
|
+
export { Users, type User, type UserListParams, type UserUpsertParams, type UsersCursorPage, } from "./users/users.mjs";
|
|
6
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,KAAK,kBAAkB,EAAE,KAAK,oBAAoB,EAAE;OACjF,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,GAC7B;OACM,EAAE,iBAAiB,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE;OACvE,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE;OACnE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,GACrB"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { Deliveries, type Delivery, type DeliveryListParams, type DeliveriesCursorPage } from "./deliveries.js";
|
|
2
|
+
export { Notifications, type Notification, type NotificationListParams, type NotificationListDeliveriesParams, type NotificationsCursorPage, } from "./notifications.js";
|
|
3
|
+
export { NotiflowsResource, type NotiflowRunResponse, type NotiflowRunParams } from "./notiflows.js";
|
|
4
|
+
export { Topics, type Topic, type TopicListParams, type TopicsCursorPage } from "./topics/topics.js";
|
|
5
|
+
export { Users, type User, type UserListParams, type UserUpsertParams, type UsersCursorPage, } from "./users/users.js";
|
|
6
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,KAAK,kBAAkB,EAAE,KAAK,oBAAoB,EAAE;OACjF,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,GAC7B;OACM,EAAE,iBAAiB,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE;OACvE,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE;OACnE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,GACrB"}
|
|
@@ -0,0 +1,15 @@
|
|
|
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.Users = exports.Topics = exports.NotiflowsResource = exports.Notifications = exports.Deliveries = void 0;
|
|
5
|
+
var deliveries_1 = require("./deliveries.js");
|
|
6
|
+
Object.defineProperty(exports, "Deliveries", { enumerable: true, get: function () { return deliveries_1.Deliveries; } });
|
|
7
|
+
var notifications_1 = require("./notifications.js");
|
|
8
|
+
Object.defineProperty(exports, "Notifications", { enumerable: true, get: function () { return notifications_1.Notifications; } });
|
|
9
|
+
var notiflows_1 = require("./notiflows.js");
|
|
10
|
+
Object.defineProperty(exports, "NotiflowsResource", { enumerable: true, get: function () { return notiflows_1.NotiflowsResource; } });
|
|
11
|
+
var topics_1 = require("./topics/topics.js");
|
|
12
|
+
Object.defineProperty(exports, "Topics", { enumerable: true, get: function () { return topics_1.Topics; } });
|
|
13
|
+
var users_1 = require("./users/users.js");
|
|
14
|
+
Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
|
|
15
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAA6G;AAApG,wGAAA,UAAU,OAAA;AACnB,oDAMyB;AALvB,8GAAA,aAAa,OAAA;AAMf,4CAAkG;AAAzF,8GAAA,iBAAiB,OAAA;AAC1B,6CAAkG;AAAzF,gGAAA,MAAM,OAAA;AACf,0CAMuB;AALrB,8FAAA,KAAK,OAAA"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
export { Deliveries } from "./deliveries.mjs";
|
|
3
|
+
export { Notifications, } from "./notifications.mjs";
|
|
4
|
+
export { NotiflowsResource } from "./notiflows.mjs";
|
|
5
|
+
export { Topics } from "./topics/topics.mjs";
|
|
6
|
+
export { Users, } from "./users/users.mjs";
|
|
7
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,UAAU,EAAqE;OACjF,EACL,aAAa,GAKd;OACM,EAAE,iBAAiB,EAAoD;OACvE,EAAE,MAAM,EAA2D;OACnE,EACL,KAAK,GAKN"}
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as DeliveriesAPI from "./deliveries.mjs";
|
|
3
|
+
import { DeliveriesCursorPage } from "./deliveries.mjs";
|
|
4
|
+
import * as UsersAPI from "./users/users.mjs";
|
|
5
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
6
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
7
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
8
|
+
export declare class Notifications extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve a single notification by ID, including the recipient, actor, and all
|
|
11
|
+
* delivery attempts.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const notification = await client.notifications.retrieve(
|
|
16
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Notification>;
|
|
21
|
+
/**
|
|
22
|
+
* Retrieve a paginated list of all notifications in your project.
|
|
23
|
+
*
|
|
24
|
+
* A notification represents a message sent to a single recipient through a
|
|
25
|
+
* notiflow run. Each notification can have multiple deliveries (one per channel).
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* // Automatically fetches more pages as needed.
|
|
30
|
+
* for await (const notification of client.notifications.list()) {
|
|
31
|
+
* // ...
|
|
32
|
+
* }
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
list(query?: NotificationListParams | null | undefined, options?: RequestOptions): PagePromise<NotificationsCursorPage, Notification>;
|
|
36
|
+
/**
|
|
37
|
+
* Retrieve all delivery attempts for a specific notification.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* // Automatically fetches more pages as needed.
|
|
42
|
+
* for await (const delivery of client.notifications.listDeliveries(
|
|
43
|
+
* '01HQXYZ123456789ABCDEFGHIJ',
|
|
44
|
+
* )) {
|
|
45
|
+
* // ...
|
|
46
|
+
* }
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
listDeliveries(notificationID: string, query?: NotificationListDeliveriesParams | null | undefined, options?: RequestOptions): PagePromise<DeliveriesCursorPage, DeliveriesAPI.Delivery>;
|
|
50
|
+
}
|
|
51
|
+
export type NotificationsCursorPage = CursorPage<Notification>;
|
|
52
|
+
/**
|
|
53
|
+
* A notification sent to a recipient through a notiflow run
|
|
54
|
+
*/
|
|
55
|
+
export interface Notification {
|
|
56
|
+
/**
|
|
57
|
+
* Notification ID
|
|
58
|
+
*/
|
|
59
|
+
id: string;
|
|
60
|
+
/**
|
|
61
|
+
* When the notification was created
|
|
62
|
+
*/
|
|
63
|
+
created_at: string;
|
|
64
|
+
/**
|
|
65
|
+
* Template variables passed when running the notiflow
|
|
66
|
+
*/
|
|
67
|
+
data: unknown;
|
|
68
|
+
/**
|
|
69
|
+
* ID of the notiflow that generated this notification
|
|
70
|
+
*/
|
|
71
|
+
notiflow_id: string;
|
|
72
|
+
/**
|
|
73
|
+
* ID of the specific notiflow run
|
|
74
|
+
*/
|
|
75
|
+
notiflow_run_id: string;
|
|
76
|
+
/**
|
|
77
|
+
* Internal ID of the recipient user
|
|
78
|
+
*/
|
|
79
|
+
recipient_id: string;
|
|
80
|
+
/**
|
|
81
|
+
* Notification processing status:
|
|
82
|
+
*
|
|
83
|
+
* - `pending`: Queued for processing
|
|
84
|
+
* - `processing`: Currently being processed
|
|
85
|
+
* - `processed`: Successfully processed (deliveries created)
|
|
86
|
+
* - `failed`: Processing failed
|
|
87
|
+
*/
|
|
88
|
+
status: 'pending' | 'processing' | 'processed' | 'failed';
|
|
89
|
+
/**
|
|
90
|
+
* When the notification was last updated
|
|
91
|
+
*/
|
|
92
|
+
updated_at: string;
|
|
93
|
+
/**
|
|
94
|
+
* A user (recipient) in your project
|
|
95
|
+
*/
|
|
96
|
+
actor?: UsersAPI.User | null;
|
|
97
|
+
/**
|
|
98
|
+
* Internal ID of the actor (user who triggered the notification)
|
|
99
|
+
*/
|
|
100
|
+
actor_id?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* Delivery attempts for this notification (when expanded)
|
|
103
|
+
*/
|
|
104
|
+
deliveries?: Array<DeliveriesAPI.Delivery>;
|
|
105
|
+
/**
|
|
106
|
+
* When the notification was processed
|
|
107
|
+
*/
|
|
108
|
+
processed_at?: string | null;
|
|
109
|
+
/**
|
|
110
|
+
* A user (recipient) in your project
|
|
111
|
+
*/
|
|
112
|
+
recipient?: UsersAPI.User;
|
|
113
|
+
/**
|
|
114
|
+
* Topic name if triggered via topic
|
|
115
|
+
*/
|
|
116
|
+
topic?: string | null;
|
|
117
|
+
}
|
|
118
|
+
export interface NotificationListParams extends CursorPageParams {
|
|
119
|
+
/**
|
|
120
|
+
* Cursor for fetching the previous page
|
|
121
|
+
*/
|
|
122
|
+
before?: string;
|
|
123
|
+
/**
|
|
124
|
+
* Filter by created after (ISO 8601 datetime)
|
|
125
|
+
*/
|
|
126
|
+
created_after?: string;
|
|
127
|
+
/**
|
|
128
|
+
* Filter by created before (ISO 8601 datetime)
|
|
129
|
+
*/
|
|
130
|
+
created_before?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Filter by status
|
|
133
|
+
*/
|
|
134
|
+
status?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Filter by topic
|
|
137
|
+
*/
|
|
138
|
+
topic?: string;
|
|
139
|
+
}
|
|
140
|
+
export interface NotificationListDeliveriesParams extends CursorPageParams {
|
|
141
|
+
/**
|
|
142
|
+
* Cursor for fetching the previous page
|
|
143
|
+
*/
|
|
144
|
+
before?: string;
|
|
145
|
+
/**
|
|
146
|
+
* Filter by channel ID (UUID)
|
|
147
|
+
*/
|
|
148
|
+
channel_id?: string;
|
|
149
|
+
/**
|
|
150
|
+
* Filter by created after (ISO 8601 datetime)
|
|
151
|
+
*/
|
|
152
|
+
created_after?: string;
|
|
153
|
+
/**
|
|
154
|
+
* Filter by created before (ISO 8601 datetime)
|
|
155
|
+
*/
|
|
156
|
+
created_before?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Filter by status (pending, sent, failed)
|
|
159
|
+
*/
|
|
160
|
+
status?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Filter by topic name
|
|
163
|
+
*/
|
|
164
|
+
topic?: string;
|
|
165
|
+
}
|
|
166
|
+
export declare namespace Notifications {
|
|
167
|
+
export { type Notification as Notification, type NotificationsCursorPage as NotificationsCursorPage, type NotificationListParams as NotificationListParams, type NotificationListDeliveriesParams as NotificationListDeliveriesParams, };
|
|
168
|
+
}
|
|
169
|
+
export { type DeliveriesCursorPage };
|
|
170
|
+
//# sourceMappingURL=notifications.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notifications.d.mts","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,oBAAoB,EAAE;OACxB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIxE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAIrD;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,cAAc,EAAE,MAAM,EACtB,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,aAAa,CAAC,QAAQ,CAAC;CAO7D;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gCAAiC,SAAQ,gBAAgB;IACxE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH;AAED,OAAO,EAAE,KAAK,oBAAoB,EAAE,CAAC"}
|