@trycourier/courier 7.24.0 → 7.25.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/CHANGELOG.md +22 -0
- package/README.md +0 -3
- package/client.d.mts +5 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -2
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/audiences.d.mts +46 -0
- package/resources/audiences.d.mts.map +1 -1
- package/resources/audiences.d.ts +46 -0
- package/resources/audiences.d.ts.map +1 -1
- package/resources/audiences.js +46 -0
- package/resources/audiences.js.map +1 -1
- package/resources/audiences.mjs +46 -0
- package/resources/audiences.mjs.map +1 -1
- package/resources/automations/invoke.d.mts +5 -1
- package/resources/automations/invoke.d.mts.map +1 -1
- package/resources/automations/invoke.d.ts +5 -1
- package/resources/automations/invoke.d.ts.map +1 -1
- package/resources/automations/invoke.js +5 -1
- package/resources/automations/invoke.js.map +1 -1
- package/resources/automations/invoke.mjs +5 -1
- package/resources/automations/invoke.mjs.map +1 -1
- package/resources/brands.d.mts +4 -1
- package/resources/brands.d.mts.map +1 -1
- package/resources/brands.d.ts +4 -1
- package/resources/brands.d.ts.map +1 -1
- package/resources/brands.js +4 -1
- package/resources/brands.js.map +1 -1
- package/resources/brands.mjs +4 -1
- package/resources/brands.mjs.map +1 -1
- package/resources/bulk.d.mts +194 -0
- package/resources/bulk.d.mts.map +1 -0
- package/resources/bulk.d.ts +194 -0
- package/resources/bulk.d.ts.map +1 -0
- package/resources/bulk.js +97 -0
- package/resources/bulk.js.map +1 -0
- package/resources/bulk.mjs +93 -0
- package/resources/bulk.mjs.map +1 -0
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/lists/lists.d.mts +3 -1
- package/resources/lists/lists.d.mts.map +1 -1
- package/resources/lists/lists.d.ts +3 -1
- package/resources/lists/lists.d.ts.map +1 -1
- package/resources/lists/lists.js +3 -1
- package/resources/lists/lists.js.map +1 -1
- package/resources/lists/lists.mjs +3 -1
- package/resources/lists/lists.mjs.map +1 -1
- package/resources/lists/subscriptions.d.mts +13 -2
- package/resources/lists/subscriptions.d.mts.map +1 -1
- package/resources/lists/subscriptions.d.ts +13 -2
- package/resources/lists/subscriptions.d.ts.map +1 -1
- package/resources/lists/subscriptions.js +13 -2
- package/resources/lists/subscriptions.js.map +1 -1
- package/resources/lists/subscriptions.mjs +13 -2
- package/resources/lists/subscriptions.mjs.map +1 -1
- package/resources/notifications/checks.d.mts +2 -2
- package/resources/notifications/checks.d.ts +2 -2
- package/resources/notifications/checks.js +2 -2
- package/resources/notifications/checks.mjs +2 -2
- package/resources/notifications/index.d.mts +1 -1
- package/resources/notifications/index.d.mts.map +1 -1
- package/resources/notifications/index.d.ts +1 -1
- package/resources/notifications/index.d.ts.map +1 -1
- package/resources/notifications/index.js.map +1 -1
- package/resources/notifications/index.mjs.map +1 -1
- package/resources/notifications/notifications.d.mts +48 -14
- package/resources/notifications/notifications.d.mts.map +1 -1
- package/resources/notifications/notifications.d.ts +48 -14
- package/resources/notifications/notifications.d.ts.map +1 -1
- package/resources/notifications/notifications.js +1 -0
- package/resources/notifications/notifications.js.map +1 -1
- package/resources/notifications/notifications.mjs +1 -0
- package/resources/notifications/notifications.mjs.map +1 -1
- package/resources/profiles/lists.d.mts +1 -1
- package/resources/profiles/lists.d.ts +1 -1
- package/resources/profiles/lists.js +1 -1
- package/resources/profiles/lists.mjs +1 -1
- package/resources/profiles/profiles.d.mts +12 -5
- package/resources/profiles/profiles.d.mts.map +1 -1
- package/resources/profiles/profiles.d.ts +12 -5
- package/resources/profiles/profiles.d.ts.map +1 -1
- package/resources/profiles/profiles.js +12 -5
- package/resources/profiles/profiles.js.map +1 -1
- package/resources/profiles/profiles.mjs +12 -5
- package/resources/profiles/profiles.mjs.map +1 -1
- package/resources/providers/providers.d.mts +6 -2
- package/resources/providers/providers.d.mts.map +1 -1
- package/resources/providers/providers.d.ts +6 -2
- package/resources/providers/providers.d.ts.map +1 -1
- package/resources/providers/providers.js +6 -2
- package/resources/providers/providers.js.map +1 -1
- package/resources/providers/providers.mjs +6 -2
- package/resources/providers/providers.mjs.map +1 -1
- package/resources/send.d.mts +2 -1
- package/resources/send.d.mts.map +1 -1
- package/resources/send.d.ts +2 -1
- package/resources/send.d.ts.map +1 -1
- package/resources/send.js +2 -1
- package/resources/send.js.map +1 -1
- package/resources/send.mjs +2 -1
- package/resources/send.mjs.map +1 -1
- package/resources/shared.d.mts +16 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +16 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/tenants/templates/templates.d.mts +7 -1
- package/resources/tenants/templates/templates.d.mts.map +1 -1
- package/resources/tenants/templates/templates.d.ts +7 -1
- package/resources/tenants/templates/templates.d.ts.map +1 -1
- package/resources/tenants/templates/templates.js +7 -1
- package/resources/tenants/templates/templates.js.map +1 -1
- package/resources/tenants/templates/templates.mjs +7 -1
- package/resources/tenants/templates/templates.mjs.map +1 -1
- package/resources/tenants/tenants.d.mts +3 -1
- package/resources/tenants/tenants.d.mts.map +1 -1
- package/resources/tenants/tenants.d.ts +3 -1
- package/resources/tenants/tenants.d.ts.map +1 -1
- package/resources/tenants/tenants.js +3 -1
- package/resources/tenants/tenants.js.map +1 -1
- package/resources/tenants/tenants.mjs +3 -1
- package/resources/tenants/tenants.mjs.map +1 -1
- package/resources/translations.d.mts +16 -0
- package/resources/translations.d.mts.map +1 -1
- package/resources/translations.d.ts +16 -0
- package/resources/translations.d.ts.map +1 -1
- package/resources/translations.js +16 -0
- package/resources/translations.js.map +1 -1
- package/resources/translations.mjs +16 -0
- package/resources/translations.mjs.map +1 -1
- package/resources/users/tenants.d.mts +5 -1
- package/resources/users/tenants.d.mts.map +1 -1
- package/resources/users/tenants.d.ts +5 -1
- package/resources/users/tenants.d.ts.map +1 -1
- package/resources/users/tenants.js +5 -1
- package/resources/users/tenants.js.map +1 -1
- package/resources/users/tenants.mjs +5 -1
- package/resources/users/tenants.mjs.map +1 -1
- package/resources/users/tokens.d.mts +8 -1
- package/resources/users/tokens.d.mts.map +1 -1
- package/resources/users/tokens.d.ts +8 -1
- package/resources/users/tokens.d.ts.map +1 -1
- package/resources/users/tokens.js +8 -1
- package/resources/users/tokens.js.map +1 -1
- package/resources/users/tokens.mjs +8 -1
- package/resources/users/tokens.mjs.map +1 -1
- package/resources/workspace-preferences/topics.d.mts +5 -2
- package/resources/workspace-preferences/topics.d.mts.map +1 -1
- package/resources/workspace-preferences/topics.d.ts +5 -2
- package/resources/workspace-preferences/topics.d.ts.map +1 -1
- package/resources/workspace-preferences/topics.js +5 -2
- package/resources/workspace-preferences/topics.js.map +1 -1
- package/resources/workspace-preferences/topics.mjs +5 -2
- package/resources/workspace-preferences/topics.mjs.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.d.mts +8 -2
- package/resources/workspace-preferences/workspace-preferences.d.mts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.d.ts +8 -2
- package/resources/workspace-preferences/workspace-preferences.d.ts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.js +8 -2
- package/resources/workspace-preferences/workspace-preferences.js.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.mjs +8 -2
- package/resources/workspace-preferences/workspace-preferences.mjs.map +1 -1
- package/src/client.ts +29 -0
- package/src/resources/audiences.ts +46 -0
- package/src/resources/automations/invoke.ts +5 -1
- package/src/resources/brands.ts +4 -1
- package/src/resources/bulk.ts +249 -0
- package/src/resources/index.ts +13 -0
- package/src/resources/lists/lists.ts +3 -1
- package/src/resources/lists/subscriptions.ts +13 -2
- package/src/resources/notifications/checks.ts +2 -2
- package/src/resources/notifications/index.ts +2 -0
- package/src/resources/notifications/notifications.ts +52 -13
- package/src/resources/profiles/lists.ts +1 -1
- package/src/resources/profiles/profiles.ts +12 -5
- package/src/resources/providers/providers.ts +6 -2
- package/src/resources/send.ts +2 -1
- package/src/resources/shared.ts +19 -0
- package/src/resources/tenants/templates/templates.ts +7 -1
- package/src/resources/tenants/tenants.ts +3 -1
- package/src/resources/translations.ts +16 -0
- package/src/resources/users/tenants.ts +5 -1
- package/src/resources/users/tokens.ts +8 -1
- package/src/resources/workspace-preferences/topics.ts +5 -2
- package/src/resources/workspace-preferences/workspace-preferences.ts +8 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAqB9E;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE
|
|
1
|
+
{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAqB9E;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI7F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMpE;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAElC,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,gBAAiB,SAAQ,SAAS,CAAC,aAAa;QAC/D,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;QAE9B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IAEpB,KAAK,EAAE,KAAK,CAAC;IAEb,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IAEjB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,EAAE,OAAO,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IAEX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
|
package/resources/brands.js
CHANGED
|
@@ -58,7 +58,10 @@ class Brands extends resource_1.APIResource {
|
|
|
58
58
|
* @example
|
|
59
59
|
* ```ts
|
|
60
60
|
* const brand = await client.brands.update('brand_id', {
|
|
61
|
-
* name: '
|
|
61
|
+
* name: 'My Brand',
|
|
62
|
+
* settings: {
|
|
63
|
+
* colors: { primary: '#9D3789', secondary: '#FFFFFF' },
|
|
64
|
+
* },
|
|
62
65
|
* });
|
|
63
66
|
* ```
|
|
64
67
|
*/
|
package/resources/brands.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"brands.js","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"brands.js","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAlGD,wBAkGC"}
|
package/resources/brands.mjs
CHANGED
|
@@ -55,7 +55,10 @@ export class Brands extends APIResource {
|
|
|
55
55
|
* @example
|
|
56
56
|
* ```ts
|
|
57
57
|
* const brand = await client.brands.update('brand_id', {
|
|
58
|
-
* name: '
|
|
58
|
+
* name: 'My Brand',
|
|
59
|
+
* settings: {
|
|
60
|
+
* colors: { primary: '#9D3789', secondary: '#FFFFFF' },
|
|
61
|
+
* },
|
|
59
62
|
* });
|
|
60
63
|
* ```
|
|
61
64
|
*/
|
package/resources/brands.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"brands.mjs","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"brands.mjs","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as BulkAPI from "./bulk.mjs";
|
|
3
|
+
import * as Shared from "./shared.mjs";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
+
export declare class Bulk extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Ingest user data into a Bulk Job.
|
|
9
|
+
*
|
|
10
|
+
* **Important**: For email-based bulk jobs, each user must include `profile.email`
|
|
11
|
+
* for provider routing to work correctly. The `to.email` field is not sufficient
|
|
12
|
+
* for email provider routing.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* await client.bulk.addUsers('job_id', {
|
|
17
|
+
* users: [
|
|
18
|
+
* {
|
|
19
|
+
* recipient: 'user_abc',
|
|
20
|
+
* profile: { email: 'jdoe@example.com' },
|
|
21
|
+
* data: { name: 'Jane' },
|
|
22
|
+
* },
|
|
23
|
+
* ],
|
|
24
|
+
* });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
addUsers(jobID: string, body: BulkAddUsersParams, options?: RequestOptions): APIPromise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Creates a new bulk job for sending messages to multiple recipients.
|
|
30
|
+
*
|
|
31
|
+
* **Required**: `message.event` (event ID or notification ID)
|
|
32
|
+
*
|
|
33
|
+
* **Optional (V2 format)**: `message.template` (notification ID) or
|
|
34
|
+
* `message.content` (Elemental content) can be provided to override the
|
|
35
|
+
* notification associated with the event.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const response = await client.bulk.createJob({
|
|
40
|
+
* message: {
|
|
41
|
+
* event: 'welcome-series',
|
|
42
|
+
* brand: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
|
|
43
|
+
* data: { campaign: 'spring-2024' },
|
|
44
|
+
* },
|
|
45
|
+
* });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
createJob(body: BulkCreateJobParams, options?: RequestOptions): APIPromise<BulkCreateJobResponse>;
|
|
49
|
+
/**
|
|
50
|
+
* Get Bulk Job Users
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const response = await client.bulk.listUsers('job_id');
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
listUsers(jobID: string, query?: BulkListUsersParams | null | undefined, options?: RequestOptions): APIPromise<BulkListUsersResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Get a bulk job
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const response = await client.bulk.retrieveJob('job_id');
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
retrieveJob(jobID: string, options?: RequestOptions): APIPromise<BulkRetrieveJobResponse>;
|
|
67
|
+
/**
|
|
68
|
+
* Run a bulk job
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* await client.bulk.runJob('job_id');
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
runJob(jobID: string, options?: RequestOptions): APIPromise<void>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Bulk message definition. Supports two formats:
|
|
79
|
+
*
|
|
80
|
+
* - V1 format: Requires `event` field (event ID or notification ID)
|
|
81
|
+
* - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
82
|
+
* content) in addition to `event`
|
|
83
|
+
*/
|
|
84
|
+
export interface InboundBulkMessage {
|
|
85
|
+
/**
|
|
86
|
+
* Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
|
|
87
|
+
* "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
|
|
88
|
+
* mapped to a notification.
|
|
89
|
+
*/
|
|
90
|
+
event: string;
|
|
91
|
+
brand?: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* Elemental content (optional, for V2 format). When provided, this will be used
|
|
94
|
+
* instead of the notification associated with the `event` field.
|
|
95
|
+
*/
|
|
96
|
+
content?: Shared.ElementalContentSugar | Shared.ElementalContent | null;
|
|
97
|
+
data?: {
|
|
98
|
+
[key: string]: unknown;
|
|
99
|
+
} | null;
|
|
100
|
+
locale?: {
|
|
101
|
+
[key: string]: {
|
|
102
|
+
[key: string]: unknown;
|
|
103
|
+
};
|
|
104
|
+
} | null;
|
|
105
|
+
override?: {
|
|
106
|
+
[key: string]: unknown;
|
|
107
|
+
} | null;
|
|
108
|
+
/**
|
|
109
|
+
* Notification ID or template ID (optional, for V2 format). When provided, this
|
|
110
|
+
* will be used instead of the notification associated with the `event` field.
|
|
111
|
+
*/
|
|
112
|
+
template?: string | null;
|
|
113
|
+
}
|
|
114
|
+
export interface InboundBulkMessageUser {
|
|
115
|
+
/**
|
|
116
|
+
* User-specific data that will be merged with message.data
|
|
117
|
+
*/
|
|
118
|
+
data?: unknown;
|
|
119
|
+
preferences?: Shared.RecipientPreferences | null;
|
|
120
|
+
/**
|
|
121
|
+
* User profile information. For email-based bulk jobs, `profile.email` is required
|
|
122
|
+
* for provider routing to determine if the message can be delivered. The email
|
|
123
|
+
* address should be provided here rather than in `to.email`.
|
|
124
|
+
*/
|
|
125
|
+
profile?: {
|
|
126
|
+
[key: string]: unknown;
|
|
127
|
+
} | null;
|
|
128
|
+
/**
|
|
129
|
+
* User ID (legacy field, use profile or to.user_id instead)
|
|
130
|
+
*/
|
|
131
|
+
recipient?: string | null;
|
|
132
|
+
/**
|
|
133
|
+
* Optional recipient information. Note: For email provider routing, use
|
|
134
|
+
* `profile.email` instead of `to.email`. The `to` field is primarily used for
|
|
135
|
+
* recipient identification and data merging.
|
|
136
|
+
*/
|
|
137
|
+
to?: Shared.UserRecipient | null;
|
|
138
|
+
}
|
|
139
|
+
export interface BulkCreateJobResponse {
|
|
140
|
+
jobId: string;
|
|
141
|
+
}
|
|
142
|
+
export interface BulkListUsersResponse {
|
|
143
|
+
items: Array<BulkListUsersResponse.Item>;
|
|
144
|
+
paging: Shared.Paging;
|
|
145
|
+
}
|
|
146
|
+
export declare namespace BulkListUsersResponse {
|
|
147
|
+
interface Item extends BulkAPI.InboundBulkMessageUser {
|
|
148
|
+
status: 'PENDING' | 'ENQUEUED' | 'ERROR';
|
|
149
|
+
messageId?: string | null;
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
export interface BulkRetrieveJobResponse {
|
|
153
|
+
job: BulkRetrieveJobResponse.Job;
|
|
154
|
+
}
|
|
155
|
+
export declare namespace BulkRetrieveJobResponse {
|
|
156
|
+
interface Job {
|
|
157
|
+
/**
|
|
158
|
+
* Bulk message definition. Supports two formats:
|
|
159
|
+
*
|
|
160
|
+
* - V1 format: Requires `event` field (event ID or notification ID)
|
|
161
|
+
* - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
162
|
+
* content) in addition to `event`
|
|
163
|
+
*/
|
|
164
|
+
definition: BulkAPI.InboundBulkMessage;
|
|
165
|
+
enqueued: number;
|
|
166
|
+
failures: number;
|
|
167
|
+
received: number;
|
|
168
|
+
status: 'CREATED' | 'PROCESSING' | 'COMPLETED' | 'ERROR';
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
export interface BulkAddUsersParams {
|
|
172
|
+
users: Array<InboundBulkMessageUser>;
|
|
173
|
+
}
|
|
174
|
+
export interface BulkCreateJobParams {
|
|
175
|
+
/**
|
|
176
|
+
* Bulk message definition. Supports two formats:
|
|
177
|
+
*
|
|
178
|
+
* - V1 format: Requires `event` field (event ID or notification ID)
|
|
179
|
+
* - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
180
|
+
* content) in addition to `event`
|
|
181
|
+
*/
|
|
182
|
+
message: InboundBulkMessage;
|
|
183
|
+
}
|
|
184
|
+
export interface BulkListUsersParams {
|
|
185
|
+
/**
|
|
186
|
+
* A unique identifier that allows for fetching the next set of users added to the
|
|
187
|
+
* bulk job
|
|
188
|
+
*/
|
|
189
|
+
cursor?: string | null;
|
|
190
|
+
}
|
|
191
|
+
export declare namespace Bulk {
|
|
192
|
+
export { type InboundBulkMessage as InboundBulkMessage, type InboundBulkMessageUser as InboundBulkMessageUser, type BulkCreateJobResponse as BulkCreateJobResponse, type BulkListUsersResponse as BulkListUsersResponse, type BulkRetrieveJobResponse as BulkRetrieveJobResponse, type BulkAddUsersParams as BulkAddUsersParams, type BulkCreateJobParams as BulkCreateJobParams, type BulkListUsersParams as BulkListUsersParams, };
|
|
193
|
+
}
|
|
194
|
+
//# sourceMappingURL=bulk.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,OAAO,mBAAe;AAClC,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjG;;;;;;;OAOG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIzF;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAExE,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9D,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAK,SAAQ,OAAO,CAAC,sBAAsB;QAC1D,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;QAEzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,uBAAuB,CAAC,GAAG,CAAC;CAClC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,GAAG;QAClB;;;;;;WAMG;QACH,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as BulkAPI from "./bulk.js";
|
|
3
|
+
import * as Shared from "./shared.js";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
+
export declare class Bulk extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Ingest user data into a Bulk Job.
|
|
9
|
+
*
|
|
10
|
+
* **Important**: For email-based bulk jobs, each user must include `profile.email`
|
|
11
|
+
* for provider routing to work correctly. The `to.email` field is not sufficient
|
|
12
|
+
* for email provider routing.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* await client.bulk.addUsers('job_id', {
|
|
17
|
+
* users: [
|
|
18
|
+
* {
|
|
19
|
+
* recipient: 'user_abc',
|
|
20
|
+
* profile: { email: 'jdoe@example.com' },
|
|
21
|
+
* data: { name: 'Jane' },
|
|
22
|
+
* },
|
|
23
|
+
* ],
|
|
24
|
+
* });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
addUsers(jobID: string, body: BulkAddUsersParams, options?: RequestOptions): APIPromise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Creates a new bulk job for sending messages to multiple recipients.
|
|
30
|
+
*
|
|
31
|
+
* **Required**: `message.event` (event ID or notification ID)
|
|
32
|
+
*
|
|
33
|
+
* **Optional (V2 format)**: `message.template` (notification ID) or
|
|
34
|
+
* `message.content` (Elemental content) can be provided to override the
|
|
35
|
+
* notification associated with the event.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const response = await client.bulk.createJob({
|
|
40
|
+
* message: {
|
|
41
|
+
* event: 'welcome-series',
|
|
42
|
+
* brand: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
|
|
43
|
+
* data: { campaign: 'spring-2024' },
|
|
44
|
+
* },
|
|
45
|
+
* });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
createJob(body: BulkCreateJobParams, options?: RequestOptions): APIPromise<BulkCreateJobResponse>;
|
|
49
|
+
/**
|
|
50
|
+
* Get Bulk Job Users
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const response = await client.bulk.listUsers('job_id');
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
listUsers(jobID: string, query?: BulkListUsersParams | null | undefined, options?: RequestOptions): APIPromise<BulkListUsersResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Get a bulk job
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const response = await client.bulk.retrieveJob('job_id');
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
retrieveJob(jobID: string, options?: RequestOptions): APIPromise<BulkRetrieveJobResponse>;
|
|
67
|
+
/**
|
|
68
|
+
* Run a bulk job
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* await client.bulk.runJob('job_id');
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
runJob(jobID: string, options?: RequestOptions): APIPromise<void>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Bulk message definition. Supports two formats:
|
|
79
|
+
*
|
|
80
|
+
* - V1 format: Requires `event` field (event ID or notification ID)
|
|
81
|
+
* - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
82
|
+
* content) in addition to `event`
|
|
83
|
+
*/
|
|
84
|
+
export interface InboundBulkMessage {
|
|
85
|
+
/**
|
|
86
|
+
* Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
|
|
87
|
+
* "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
|
|
88
|
+
* mapped to a notification.
|
|
89
|
+
*/
|
|
90
|
+
event: string;
|
|
91
|
+
brand?: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* Elemental content (optional, for V2 format). When provided, this will be used
|
|
94
|
+
* instead of the notification associated with the `event` field.
|
|
95
|
+
*/
|
|
96
|
+
content?: Shared.ElementalContentSugar | Shared.ElementalContent | null;
|
|
97
|
+
data?: {
|
|
98
|
+
[key: string]: unknown;
|
|
99
|
+
} | null;
|
|
100
|
+
locale?: {
|
|
101
|
+
[key: string]: {
|
|
102
|
+
[key: string]: unknown;
|
|
103
|
+
};
|
|
104
|
+
} | null;
|
|
105
|
+
override?: {
|
|
106
|
+
[key: string]: unknown;
|
|
107
|
+
} | null;
|
|
108
|
+
/**
|
|
109
|
+
* Notification ID or template ID (optional, for V2 format). When provided, this
|
|
110
|
+
* will be used instead of the notification associated with the `event` field.
|
|
111
|
+
*/
|
|
112
|
+
template?: string | null;
|
|
113
|
+
}
|
|
114
|
+
export interface InboundBulkMessageUser {
|
|
115
|
+
/**
|
|
116
|
+
* User-specific data that will be merged with message.data
|
|
117
|
+
*/
|
|
118
|
+
data?: unknown;
|
|
119
|
+
preferences?: Shared.RecipientPreferences | null;
|
|
120
|
+
/**
|
|
121
|
+
* User profile information. For email-based bulk jobs, `profile.email` is required
|
|
122
|
+
* for provider routing to determine if the message can be delivered. The email
|
|
123
|
+
* address should be provided here rather than in `to.email`.
|
|
124
|
+
*/
|
|
125
|
+
profile?: {
|
|
126
|
+
[key: string]: unknown;
|
|
127
|
+
} | null;
|
|
128
|
+
/**
|
|
129
|
+
* User ID (legacy field, use profile or to.user_id instead)
|
|
130
|
+
*/
|
|
131
|
+
recipient?: string | null;
|
|
132
|
+
/**
|
|
133
|
+
* Optional recipient information. Note: For email provider routing, use
|
|
134
|
+
* `profile.email` instead of `to.email`. The `to` field is primarily used for
|
|
135
|
+
* recipient identification and data merging.
|
|
136
|
+
*/
|
|
137
|
+
to?: Shared.UserRecipient | null;
|
|
138
|
+
}
|
|
139
|
+
export interface BulkCreateJobResponse {
|
|
140
|
+
jobId: string;
|
|
141
|
+
}
|
|
142
|
+
export interface BulkListUsersResponse {
|
|
143
|
+
items: Array<BulkListUsersResponse.Item>;
|
|
144
|
+
paging: Shared.Paging;
|
|
145
|
+
}
|
|
146
|
+
export declare namespace BulkListUsersResponse {
|
|
147
|
+
interface Item extends BulkAPI.InboundBulkMessageUser {
|
|
148
|
+
status: 'PENDING' | 'ENQUEUED' | 'ERROR';
|
|
149
|
+
messageId?: string | null;
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
export interface BulkRetrieveJobResponse {
|
|
153
|
+
job: BulkRetrieveJobResponse.Job;
|
|
154
|
+
}
|
|
155
|
+
export declare namespace BulkRetrieveJobResponse {
|
|
156
|
+
interface Job {
|
|
157
|
+
/**
|
|
158
|
+
* Bulk message definition. Supports two formats:
|
|
159
|
+
*
|
|
160
|
+
* - V1 format: Requires `event` field (event ID or notification ID)
|
|
161
|
+
* - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
162
|
+
* content) in addition to `event`
|
|
163
|
+
*/
|
|
164
|
+
definition: BulkAPI.InboundBulkMessage;
|
|
165
|
+
enqueued: number;
|
|
166
|
+
failures: number;
|
|
167
|
+
received: number;
|
|
168
|
+
status: 'CREATED' | 'PROCESSING' | 'COMPLETED' | 'ERROR';
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
export interface BulkAddUsersParams {
|
|
172
|
+
users: Array<InboundBulkMessageUser>;
|
|
173
|
+
}
|
|
174
|
+
export interface BulkCreateJobParams {
|
|
175
|
+
/**
|
|
176
|
+
* Bulk message definition. Supports two formats:
|
|
177
|
+
*
|
|
178
|
+
* - V1 format: Requires `event` field (event ID or notification ID)
|
|
179
|
+
* - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
180
|
+
* content) in addition to `event`
|
|
181
|
+
*/
|
|
182
|
+
message: InboundBulkMessage;
|
|
183
|
+
}
|
|
184
|
+
export interface BulkListUsersParams {
|
|
185
|
+
/**
|
|
186
|
+
* A unique identifier that allows for fetching the next set of users added to the
|
|
187
|
+
* bulk job
|
|
188
|
+
*/
|
|
189
|
+
cursor?: string | null;
|
|
190
|
+
}
|
|
191
|
+
export declare namespace Bulk {
|
|
192
|
+
export { type InboundBulkMessage as InboundBulkMessage, type InboundBulkMessageUser as InboundBulkMessageUser, type BulkCreateJobResponse as BulkCreateJobResponse, type BulkListUsersResponse as BulkListUsersResponse, type BulkRetrieveJobResponse as BulkRetrieveJobResponse, type BulkAddUsersParams as BulkAddUsersParams, type BulkCreateJobParams as BulkCreateJobParams, type BulkListUsersParams as BulkListUsersParams, };
|
|
193
|
+
}
|
|
194
|
+
//# sourceMappingURL=bulk.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,OAAO,kBAAe;AAClC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjG;;;;;;;OAOG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIzF;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAExE,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9D,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAK,SAAQ,OAAO,CAAC,sBAAsB;QAC1D,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;QAEzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,uBAAuB,CAAC,GAAG,CAAC;CAClC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,GAAG;QAClB;;;;;;WAMG;QACH,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,97 @@
|
|
|
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.Bulk = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class Bulk extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Ingest user data into a Bulk Job.
|
|
11
|
+
*
|
|
12
|
+
* **Important**: For email-based bulk jobs, each user must include `profile.email`
|
|
13
|
+
* for provider routing to work correctly. The `to.email` field is not sufficient
|
|
14
|
+
* for email provider routing.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* await client.bulk.addUsers('job_id', {
|
|
19
|
+
* users: [
|
|
20
|
+
* {
|
|
21
|
+
* recipient: 'user_abc',
|
|
22
|
+
* profile: { email: 'jdoe@example.com' },
|
|
23
|
+
* data: { name: 'Jane' },
|
|
24
|
+
* },
|
|
25
|
+
* ],
|
|
26
|
+
* });
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
addUsers(jobID, body, options) {
|
|
30
|
+
return this._client.post((0, path_1.path) `/bulk/${jobID}`, {
|
|
31
|
+
body,
|
|
32
|
+
...options,
|
|
33
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Creates a new bulk job for sending messages to multiple recipients.
|
|
38
|
+
*
|
|
39
|
+
* **Required**: `message.event` (event ID or notification ID)
|
|
40
|
+
*
|
|
41
|
+
* **Optional (V2 format)**: `message.template` (notification ID) or
|
|
42
|
+
* `message.content` (Elemental content) can be provided to override the
|
|
43
|
+
* notification associated with the event.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const response = await client.bulk.createJob({
|
|
48
|
+
* message: {
|
|
49
|
+
* event: 'welcome-series',
|
|
50
|
+
* brand: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
|
|
51
|
+
* data: { campaign: 'spring-2024' },
|
|
52
|
+
* },
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
createJob(body, options) {
|
|
57
|
+
return this._client.post('/bulk', { body, ...options });
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Get Bulk Job Users
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const response = await client.bulk.listUsers('job_id');
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
listUsers(jobID, query = {}, options) {
|
|
68
|
+
return this._client.get((0, path_1.path) `/bulk/${jobID}/users`, { query, ...options });
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Get a bulk job
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* ```ts
|
|
75
|
+
* const response = await client.bulk.retrieveJob('job_id');
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
retrieveJob(jobID, options) {
|
|
79
|
+
return this._client.get((0, path_1.path) `/bulk/${jobID}`, options);
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Run a bulk job
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* await client.bulk.runJob('job_id');
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
runJob(jobID, options) {
|
|
90
|
+
return this._client.post((0, path_1.path) `/bulk/${jobID}/run`, {
|
|
91
|
+
...options,
|
|
92
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
exports.Bulk = Bulk;
|
|
97
|
+
//# sourceMappingURL=bulk.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,EAAE,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAyB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,KAAa,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,MAAM,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA/FD,oBA+FC"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../internal/headers.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class Bulk extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Ingest user data into a Bulk Job.
|
|
8
|
+
*
|
|
9
|
+
* **Important**: For email-based bulk jobs, each user must include `profile.email`
|
|
10
|
+
* for provider routing to work correctly. The `to.email` field is not sufficient
|
|
11
|
+
* for email provider routing.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* await client.bulk.addUsers('job_id', {
|
|
16
|
+
* users: [
|
|
17
|
+
* {
|
|
18
|
+
* recipient: 'user_abc',
|
|
19
|
+
* profile: { email: 'jdoe@example.com' },
|
|
20
|
+
* data: { name: 'Jane' },
|
|
21
|
+
* },
|
|
22
|
+
* ],
|
|
23
|
+
* });
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
addUsers(jobID, body, options) {
|
|
27
|
+
return this._client.post(path `/bulk/${jobID}`, {
|
|
28
|
+
body,
|
|
29
|
+
...options,
|
|
30
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Creates a new bulk job for sending messages to multiple recipients.
|
|
35
|
+
*
|
|
36
|
+
* **Required**: `message.event` (event ID or notification ID)
|
|
37
|
+
*
|
|
38
|
+
* **Optional (V2 format)**: `message.template` (notification ID) or
|
|
39
|
+
* `message.content` (Elemental content) can be provided to override the
|
|
40
|
+
* notification associated with the event.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const response = await client.bulk.createJob({
|
|
45
|
+
* message: {
|
|
46
|
+
* event: 'welcome-series',
|
|
47
|
+
* brand: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
|
|
48
|
+
* data: { campaign: 'spring-2024' },
|
|
49
|
+
* },
|
|
50
|
+
* });
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
createJob(body, options) {
|
|
54
|
+
return this._client.post('/bulk', { body, ...options });
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Get Bulk Job Users
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* const response = await client.bulk.listUsers('job_id');
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
listUsers(jobID, query = {}, options) {
|
|
65
|
+
return this._client.get(path `/bulk/${jobID}/users`, { query, ...options });
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Get a bulk job
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* const response = await client.bulk.retrieveJob('job_id');
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
retrieveJob(jobID, options) {
|
|
76
|
+
return this._client.get(path `/bulk/${jobID}`, options);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Run a bulk job
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* await client.bulk.runJob('job_id');
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
runJob(jobID, options) {
|
|
87
|
+
return this._client.post(path `/bulk/${jobID}/run`, {
|
|
88
|
+
...options,
|
|
89
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
//# sourceMappingURL=bulk.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,EAAE,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAyB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,KAAK,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,KAAa,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,MAAM,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|