sequenzy 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/LICENSE +201 -0
- package/README.md +358 -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 +183 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +183 -0
- package/client.d.ts.map +1 -0
- package/client.js +464 -0
- package/client.js.map +1 -0
- package/client.mjs +460 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -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 +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/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 +137 -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/index.d.mts +3 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +9 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -0
- package/resources/subscribers/events.d.mts +107 -0
- package/resources/subscribers/events.d.mts.map +1 -0
- package/resources/subscribers/events.d.ts +107 -0
- package/resources/subscribers/events.d.ts.map +1 -0
- package/resources/subscribers/events.js +40 -0
- package/resources/subscribers/events.js.map +1 -0
- package/resources/subscribers/events.mjs +36 -0
- package/resources/subscribers/events.mjs.map +1 -0
- package/resources/subscribers/index.d.mts +4 -0
- package/resources/subscribers/index.d.mts.map +1 -0
- package/resources/subscribers/index.d.ts +4 -0
- package/resources/subscribers/index.d.ts.map +1 -0
- package/resources/subscribers/index.js +11 -0
- package/resources/subscribers/index.js.map +1 -0
- package/resources/subscribers/index.mjs +5 -0
- package/resources/subscribers/index.mjs.map +1 -0
- package/resources/subscribers/subscribers.d.mts +146 -0
- package/resources/subscribers/subscribers.d.mts.map +1 -0
- package/resources/subscribers/subscribers.d.ts +146 -0
- package/resources/subscribers/subscribers.d.ts.map +1 -0
- package/resources/subscribers/subscribers.js +82 -0
- package/resources/subscribers/subscribers.js.map +1 -0
- package/resources/subscribers/subscribers.mjs +77 -0
- package/resources/subscribers/subscribers.mjs.map +1 -0
- package/resources/subscribers/tags.d.mts +99 -0
- package/resources/subscribers/tags.d.mts.map +1 -0
- package/resources/subscribers/tags.d.ts +99 -0
- package/resources/subscribers/tags.d.ts.map +1 -0
- package/resources/subscribers/tags.js +39 -0
- package/resources/subscribers/tags.js.map +1 -0
- package/resources/subscribers/tags.mjs +35 -0
- package/resources/subscribers/tags.mjs.map +1 -0
- package/resources/subscribers.d.mts +2 -0
- package/resources/subscribers.d.mts.map +1 -0
- package/resources/subscribers.d.ts +2 -0
- package/resources/subscribers.d.ts.map +1 -0
- package/resources/subscribers.js +6 -0
- package/resources/subscribers.js.map +1 -0
- package/resources/subscribers.mjs +3 -0
- package/resources/subscribers.mjs.map +1 -0
- package/resources/transactional.d.mts +121 -0
- package/resources/transactional.d.mts.map +1 -0
- package/resources/transactional.d.ts +121 -0
- package/resources/transactional.d.ts.map +1 -0
- package/resources/transactional.js +56 -0
- package/resources/transactional.js.map +1 -0
- package/resources/transactional.mjs +52 -0
- package/resources/transactional.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 +767 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/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/resource.ts +2 -0
- package/src/resources/index.ts +22 -0
- package/src/resources/subscribers/events.ts +142 -0
- package/src/resources/subscribers/index.ts +28 -0
- package/src/resources/subscribers/subscribers.ts +238 -0
- package/src/resources/subscribers/tags.ts +133 -0
- package/src/resources/subscribers.ts +3 -0
- package/src/resources/transactional.ts +167 -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 @@
|
|
|
1
|
+
{"version":3,"file":"tags.d.mts","sourceRoot":"","sources":["../../src/resources/subscribers/tags.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI7E;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtG;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,GAAG,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC;CAC1B;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,UAAU;QACzB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,UAAiB,GAAG;QAClB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAE/C,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IAEd,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -0,0 +1,99 @@
|
|
|
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 Tags extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Adds a tag to a subscriber. Creates the subscriber if they don't exist. Creates
|
|
7
|
+
* the tag definition if it doesn't exist.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const response = await client.subscribers.tags.add({
|
|
12
|
+
* email: 'user@example.com',
|
|
13
|
+
* tag: 'premium',
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
add(body: TagAddParams, options?: RequestOptions): APIPromise<TagAddResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Adds multiple tags to a subscriber. Creates the subscriber if they don't exist.
|
|
20
|
+
* Creates tag definitions if they don't exist.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const response = await client.subscribers.tags.addMultiple({
|
|
25
|
+
* email: 'user@example.com',
|
|
26
|
+
* tags: ['premium', 'newsletter', 'vip'],
|
|
27
|
+
* });
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
addMultiple(body: TagAddMultipleParams, options?: RequestOptions): APIPromise<TagAddMultipleResponse>;
|
|
31
|
+
}
|
|
32
|
+
export interface TagAddResponse {
|
|
33
|
+
subscriber?: TagAddResponse.Subscriber;
|
|
34
|
+
success?: boolean;
|
|
35
|
+
tag?: TagAddResponse.Tag;
|
|
36
|
+
}
|
|
37
|
+
export declare namespace TagAddResponse {
|
|
38
|
+
interface Subscriber {
|
|
39
|
+
id?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Whether the subscriber was newly created
|
|
42
|
+
*/
|
|
43
|
+
created?: boolean;
|
|
44
|
+
email?: string;
|
|
45
|
+
tags?: Array<string>;
|
|
46
|
+
}
|
|
47
|
+
interface Tag {
|
|
48
|
+
id?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Whether the tag definition was newly created
|
|
51
|
+
*/
|
|
52
|
+
created?: boolean;
|
|
53
|
+
name?: string;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
export interface TagAddMultipleResponse {
|
|
57
|
+
subscriber?: TagAddMultipleResponse.Subscriber;
|
|
58
|
+
success?: boolean;
|
|
59
|
+
tags?: TagAddMultipleResponse.Tags;
|
|
60
|
+
}
|
|
61
|
+
export declare namespace TagAddMultipleResponse {
|
|
62
|
+
interface Subscriber {
|
|
63
|
+
id?: string;
|
|
64
|
+
created?: boolean;
|
|
65
|
+
email?: string;
|
|
66
|
+
tags?: Array<string>;
|
|
67
|
+
}
|
|
68
|
+
interface Tags {
|
|
69
|
+
/**
|
|
70
|
+
* Tag names that were added
|
|
71
|
+
*/
|
|
72
|
+
added?: Array<string>;
|
|
73
|
+
/**
|
|
74
|
+
* Tag definitions that were newly created
|
|
75
|
+
*/
|
|
76
|
+
created?: Array<string>;
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
export interface TagAddParams {
|
|
80
|
+
email: string;
|
|
81
|
+
tag: string;
|
|
82
|
+
/**
|
|
83
|
+
* Optional attributes to set on the subscriber if created
|
|
84
|
+
*/
|
|
85
|
+
customAttributes?: {
|
|
86
|
+
[key: string]: unknown;
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
export interface TagAddMultipleParams {
|
|
90
|
+
email: string;
|
|
91
|
+
tags: Array<string>;
|
|
92
|
+
customAttributes?: {
|
|
93
|
+
[key: string]: unknown;
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
export declare namespace Tags {
|
|
97
|
+
export { type TagAddResponse as TagAddResponse, type TagAddMultipleResponse as TagAddMultipleResponse, type TagAddParams as TagAddParams, type TagAddMultipleParams as TagAddMultipleParams, };
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=tags.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../src/resources/subscribers/tags.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI7E;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtG;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,GAAG,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC;CAC1B;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,UAAU;QACzB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,UAAiB,GAAG;QAClB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAE/C,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IAEd,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -0,0 +1,39 @@
|
|
|
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.Tags = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
class Tags extends resource_1.APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Adds a tag to a subscriber. Creates the subscriber if they don't exist. Creates
|
|
9
|
+
* the tag definition if it doesn't exist.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const response = await client.subscribers.tags.add({
|
|
14
|
+
* email: 'user@example.com',
|
|
15
|
+
* tag: 'premium',
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
add(body, options) {
|
|
20
|
+
return this._client.post('/subscribers/tags', { body, ...options });
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Adds multiple tags to a subscriber. Creates the subscriber if they don't exist.
|
|
24
|
+
* Creates tag definitions if they don't exist.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const response = await client.subscribers.tags.addMultiple({
|
|
29
|
+
* email: 'user@example.com',
|
|
30
|
+
* tags: ['premium', 'newsletter', 'vip'],
|
|
31
|
+
* });
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
addMultiple(body, options) {
|
|
35
|
+
return this._client.post('/subscribers/tags/bulk', { body, ...options });
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
exports.Tags = Tags;
|
|
39
|
+
//# sourceMappingURL=tags.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/resources/subscribers/tags.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,IAA0B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAhCD,oBAgCC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
export class Tags extends APIResource {
|
|
4
|
+
/**
|
|
5
|
+
* Adds a tag to a subscriber. Creates the subscriber if they don't exist. Creates
|
|
6
|
+
* the tag definition if it doesn't exist.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const response = await client.subscribers.tags.add({
|
|
11
|
+
* email: 'user@example.com',
|
|
12
|
+
* tag: 'premium',
|
|
13
|
+
* });
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
add(body, options) {
|
|
17
|
+
return this._client.post('/subscribers/tags', { body, ...options });
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Adds multiple tags to a subscriber. Creates the subscriber if they don't exist.
|
|
21
|
+
* Creates tag definitions if they don't exist.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const response = await client.subscribers.tags.addMultiple({
|
|
26
|
+
* email: 'user@example.com',
|
|
27
|
+
* tags: ['premium', 'newsletter', 'vip'],
|
|
28
|
+
* });
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
addMultiple(body, options) {
|
|
32
|
+
return this._client.post('/subscribers/tags/bulk', { body, ...options });
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=tags.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tags.mjs","sourceRoot":"","sources":["../../src/resources/subscribers/tags.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,IAA0B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribers.d.mts","sourceRoot":"","sources":["../src/resources/subscribers.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../src/resources/subscribers.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("./subscribers/index.js"), exports);
|
|
6
|
+
//# sourceMappingURL=subscribers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribers.js","sourceRoot":"","sources":["../src/resources/subscribers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,iEAAoC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribers.mjs","sourceRoot":"","sources":["../src/resources/subscribers.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as TransactionalAPI from "./transactional.mjs";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class Transactional extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Gets details of a transactional email template including available template
|
|
8
|
+
* variables.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const transactional = await client.transactional.retrieve(
|
|
13
|
+
* 'welcome-email',
|
|
14
|
+
* );
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
retrieve(slug: string, options?: RequestOptions): APIPromise<TransactionalRetrieveResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Lists all transactional email templates for your company.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const transactionals = await client.transactional.list();
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
list(options?: RequestOptions): APIPromise<TransactionalListResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* Queues a transactional email for sending. You can either:
|
|
29
|
+
*
|
|
30
|
+
* - Provide a `slug` to use a saved template
|
|
31
|
+
* - Provide `subject` and `body` to send custom content directly
|
|
32
|
+
*
|
|
33
|
+
* Variables can be passed to customize the email content. Returns immediately with
|
|
34
|
+
* a job ID.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const response = await client.transactional.send({
|
|
39
|
+
* to: 'recipient@example.com',
|
|
40
|
+
* slug: 'welcome-email',
|
|
41
|
+
* variables: { NAME: 'John' },
|
|
42
|
+
* });
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
send(body: TransactionalSendParams, options?: RequestOptions): APIPromise<TransactionalSendResponse>;
|
|
46
|
+
}
|
|
47
|
+
export interface TransactionalEmail {
|
|
48
|
+
id?: string;
|
|
49
|
+
createdAt?: string;
|
|
50
|
+
enabled?: boolean;
|
|
51
|
+
name?: string;
|
|
52
|
+
slug?: string;
|
|
53
|
+
updatedAt?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface TransactionalRetrieveResponse {
|
|
56
|
+
success?: boolean;
|
|
57
|
+
transactional?: TransactionalRetrieveResponse.Transactional;
|
|
58
|
+
}
|
|
59
|
+
export declare namespace TransactionalRetrieveResponse {
|
|
60
|
+
interface Transactional extends TransactionalAPI.TransactionalEmail {
|
|
61
|
+
variables?: Array<string>;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
export interface TransactionalListResponse {
|
|
65
|
+
success?: boolean;
|
|
66
|
+
transactional?: Array<TransactionalEmail>;
|
|
67
|
+
}
|
|
68
|
+
export type TransactionalSendResponse = TransactionalSendResponse.SlugBasedResponse | TransactionalSendResponse.DirectContentResponse;
|
|
69
|
+
export declare namespace TransactionalSendResponse {
|
|
70
|
+
interface SlugBasedResponse {
|
|
71
|
+
jobId?: string;
|
|
72
|
+
success?: boolean;
|
|
73
|
+
to?: string;
|
|
74
|
+
transactional?: SlugBasedResponse.Transactional;
|
|
75
|
+
}
|
|
76
|
+
namespace SlugBasedResponse {
|
|
77
|
+
interface Transactional {
|
|
78
|
+
id?: string;
|
|
79
|
+
name?: string;
|
|
80
|
+
slug?: string;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
interface DirectContentResponse {
|
|
84
|
+
jobId?: string;
|
|
85
|
+
success?: boolean;
|
|
86
|
+
to?: string;
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
export interface TransactionalSendParams {
|
|
90
|
+
/**
|
|
91
|
+
* Recipient email address
|
|
92
|
+
*/
|
|
93
|
+
to: string;
|
|
94
|
+
/**
|
|
95
|
+
* Email body HTML content (required if not using slug)
|
|
96
|
+
*/
|
|
97
|
+
body?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Preview text for the email (only used with direct content)
|
|
100
|
+
*/
|
|
101
|
+
preview?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Slug of the transactional email template to use (mutually exclusive with
|
|
104
|
+
* subject/body)
|
|
105
|
+
*/
|
|
106
|
+
slug?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Email subject (required if not using slug)
|
|
109
|
+
*/
|
|
110
|
+
subject?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Variables for template replacement (works with both modes)
|
|
113
|
+
*/
|
|
114
|
+
variables?: {
|
|
115
|
+
[key: string]: unknown;
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
export declare namespace Transactional {
|
|
119
|
+
export { type TransactionalEmail as TransactionalEmail, type TransactionalRetrieveResponse as TransactionalRetrieveResponse, type TransactionalListResponse as TransactionalListResponse, type TransactionalSendResponse as TransactionalSendResponse, type TransactionalSendParams as TransactionalSendParams, };
|
|
120
|
+
}
|
|
121
|
+
//# sourceMappingURL=transactional.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transactional.d.mts","sourceRoot":"","sources":["../src/resources/transactional.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAI3F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIrE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGrG;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,aAAa,CAAC,EAAE,6BAA6B,CAAC,aAAa,CAAC;CAC7D;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,aAAc,SAAQ,gBAAgB,CAAC,kBAAkB;QACxE,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,aAAa,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CAC3C;AAED,MAAM,MAAM,yBAAyB,GACjC,yBAAyB,CAAC,iBAAiB,GAC3C,yBAAyB,CAAC,qBAAqB,CAAC;AAEpD,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,iBAAiB;QAChC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,CAAC;KACjD;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,aAAa;YAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED,UAAiB,qBAAqB;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACxC;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as TransactionalAPI from "./transactional.js";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class Transactional extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Gets details of a transactional email template including available template
|
|
8
|
+
* variables.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const transactional = await client.transactional.retrieve(
|
|
13
|
+
* 'welcome-email',
|
|
14
|
+
* );
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
retrieve(slug: string, options?: RequestOptions): APIPromise<TransactionalRetrieveResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Lists all transactional email templates for your company.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const transactionals = await client.transactional.list();
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
list(options?: RequestOptions): APIPromise<TransactionalListResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* Queues a transactional email for sending. You can either:
|
|
29
|
+
*
|
|
30
|
+
* - Provide a `slug` to use a saved template
|
|
31
|
+
* - Provide `subject` and `body` to send custom content directly
|
|
32
|
+
*
|
|
33
|
+
* Variables can be passed to customize the email content. Returns immediately with
|
|
34
|
+
* a job ID.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const response = await client.transactional.send({
|
|
39
|
+
* to: 'recipient@example.com',
|
|
40
|
+
* slug: 'welcome-email',
|
|
41
|
+
* variables: { NAME: 'John' },
|
|
42
|
+
* });
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
send(body: TransactionalSendParams, options?: RequestOptions): APIPromise<TransactionalSendResponse>;
|
|
46
|
+
}
|
|
47
|
+
export interface TransactionalEmail {
|
|
48
|
+
id?: string;
|
|
49
|
+
createdAt?: string;
|
|
50
|
+
enabled?: boolean;
|
|
51
|
+
name?: string;
|
|
52
|
+
slug?: string;
|
|
53
|
+
updatedAt?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface TransactionalRetrieveResponse {
|
|
56
|
+
success?: boolean;
|
|
57
|
+
transactional?: TransactionalRetrieveResponse.Transactional;
|
|
58
|
+
}
|
|
59
|
+
export declare namespace TransactionalRetrieveResponse {
|
|
60
|
+
interface Transactional extends TransactionalAPI.TransactionalEmail {
|
|
61
|
+
variables?: Array<string>;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
export interface TransactionalListResponse {
|
|
65
|
+
success?: boolean;
|
|
66
|
+
transactional?: Array<TransactionalEmail>;
|
|
67
|
+
}
|
|
68
|
+
export type TransactionalSendResponse = TransactionalSendResponse.SlugBasedResponse | TransactionalSendResponse.DirectContentResponse;
|
|
69
|
+
export declare namespace TransactionalSendResponse {
|
|
70
|
+
interface SlugBasedResponse {
|
|
71
|
+
jobId?: string;
|
|
72
|
+
success?: boolean;
|
|
73
|
+
to?: string;
|
|
74
|
+
transactional?: SlugBasedResponse.Transactional;
|
|
75
|
+
}
|
|
76
|
+
namespace SlugBasedResponse {
|
|
77
|
+
interface Transactional {
|
|
78
|
+
id?: string;
|
|
79
|
+
name?: string;
|
|
80
|
+
slug?: string;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
interface DirectContentResponse {
|
|
84
|
+
jobId?: string;
|
|
85
|
+
success?: boolean;
|
|
86
|
+
to?: string;
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
export interface TransactionalSendParams {
|
|
90
|
+
/**
|
|
91
|
+
* Recipient email address
|
|
92
|
+
*/
|
|
93
|
+
to: string;
|
|
94
|
+
/**
|
|
95
|
+
* Email body HTML content (required if not using slug)
|
|
96
|
+
*/
|
|
97
|
+
body?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Preview text for the email (only used with direct content)
|
|
100
|
+
*/
|
|
101
|
+
preview?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Slug of the transactional email template to use (mutually exclusive with
|
|
104
|
+
* subject/body)
|
|
105
|
+
*/
|
|
106
|
+
slug?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Email subject (required if not using slug)
|
|
109
|
+
*/
|
|
110
|
+
subject?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Variables for template replacement (works with both modes)
|
|
113
|
+
*/
|
|
114
|
+
variables?: {
|
|
115
|
+
[key: string]: unknown;
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
export declare namespace Transactional {
|
|
119
|
+
export { type TransactionalEmail as TransactionalEmail, type TransactionalRetrieveResponse as TransactionalRetrieveResponse, type TransactionalListResponse as TransactionalListResponse, type TransactionalSendResponse as TransactionalSendResponse, type TransactionalSendParams as TransactionalSendParams, };
|
|
120
|
+
}
|
|
121
|
+
//# sourceMappingURL=transactional.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transactional.d.ts","sourceRoot":"","sources":["../src/resources/transactional.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAI3F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIrE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGrG;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,aAAa,CAAC,EAAE,6BAA6B,CAAC,aAAa,CAAC;CAC7D;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,aAAc,SAAQ,gBAAgB,CAAC,kBAAkB;QACxE,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,aAAa,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CAC3C;AAED,MAAM,MAAM,yBAAyB,GACjC,yBAAyB,CAAC,iBAAiB,GAC3C,yBAAyB,CAAC,qBAAqB,CAAC;AAEpD,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,iBAAiB;QAChC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,CAAC;KACjD;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,aAAa;YAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED,UAAiB,qBAAqB;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACxC;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -0,0 +1,56 @@
|
|
|
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.Transactional = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class Transactional extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Gets details of a transactional email template including available template
|
|
10
|
+
* variables.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const transactional = await client.transactional.retrieve(
|
|
15
|
+
* 'welcome-email',
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
retrieve(slug, options) {
|
|
20
|
+
return this._client.get((0, path_1.path) `/transactional/${slug}`, options);
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Lists all transactional email templates for your company.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const transactionals = await client.transactional.list();
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
list(options) {
|
|
31
|
+
return this._client.get('/transactional', options);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Queues a transactional email for sending. You can either:
|
|
35
|
+
*
|
|
36
|
+
* - Provide a `slug` to use a saved template
|
|
37
|
+
* - Provide `subject` and `body` to send custom content directly
|
|
38
|
+
*
|
|
39
|
+
* Variables can be passed to customize the email content. Returns immediately with
|
|
40
|
+
* a job ID.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const response = await client.transactional.send({
|
|
45
|
+
* to: 'recipient@example.com',
|
|
46
|
+
* slug: 'welcome-email',
|
|
47
|
+
* variables: { NAME: 'John' },
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
send(body, options) {
|
|
52
|
+
return this._client.post('/transactional/send', { body, ...options });
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
exports.Transactional = Transactional;
|
|
56
|
+
//# sourceMappingURL=transactional.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transactional.js","sourceRoot":"","sources":["../src/resources/transactional.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,IAA6B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAjDD,sCAiDC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class Transactional extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Gets details of a transactional email template including available template
|
|
7
|
+
* variables.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const transactional = await client.transactional.retrieve(
|
|
12
|
+
* 'welcome-email',
|
|
13
|
+
* );
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
retrieve(slug, options) {
|
|
17
|
+
return this._client.get(path `/transactional/${slug}`, options);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Lists all transactional email templates for your company.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const transactionals = await client.transactional.list();
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
list(options) {
|
|
28
|
+
return this._client.get('/transactional', options);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Queues a transactional email for sending. You can either:
|
|
32
|
+
*
|
|
33
|
+
* - Provide a `slug` to use a saved template
|
|
34
|
+
* - Provide `subject` and `body` to send custom content directly
|
|
35
|
+
*
|
|
36
|
+
* Variables can be passed to customize the email content. Returns immediately with
|
|
37
|
+
* a job ID.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const response = await client.transactional.send({
|
|
42
|
+
* to: 'recipient@example.com',
|
|
43
|
+
* slug: 'welcome-email',
|
|
44
|
+
* variables: { NAME: 'John' },
|
|
45
|
+
* });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
send(body, options) {
|
|
49
|
+
return this._client.post('/transactional/send', { body, ...options });
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=transactional.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transactional.mjs","sourceRoot":"","sources":["../src/resources/transactional.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,IAA6B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
|
package/resources.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.mts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.js
ADDED
package/resources.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}
|
package/resources.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|