@trycourier/courier 5.0.0 → 5.2.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.
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,53 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __generator = (this && this.__generator) || function (thisArg, body) {
12
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
13
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
+ function verb(n) { return function (v) { return step([n, v]); }; }
15
+ function step(op) {
16
+ if (f) throw new TypeError("Generator is already executing.");
17
+ while (_) try {
18
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
19
+ if (y = 0, t) op = [op[0] & 2, t.value];
20
+ switch (op[0]) {
21
+ case 0: case 1: t = op; break;
22
+ case 4: _.label++; return { value: op[1], done: false };
23
+ case 5: _.label++; y = op[1]; op = [0]; continue;
24
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
+ default:
26
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
+ if (t[2]) _.ops.pop();
31
+ _.trys.pop(); continue;
32
+ }
33
+ op = body.call(thisArg, _);
34
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
+ }
37
+ };
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ var postIssueToken = function (options) {
40
+ return function (scope, expires_in) { return __awaiter(void 0, void 0, void 0, function () {
41
+ return __generator(this, function (_a) {
42
+ switch (_a.label) {
43
+ case 0: return [4 /*yield*/, options.httpClient.post("/auth/issue-token", {
44
+ scope: scope,
45
+ expires_in: expires_in
46
+ })];
47
+ case 1:
48
+ _a.sent();
49
+ return [2 /*return*/];
50
+ }
51
+ });
52
+ }); };
53
+ };
@@ -0,0 +1,6 @@
1
+ export interface ICourierAuthIssueTokenResponse {
2
+ token?: string;
3
+ }
4
+ export interface ICourierClientAuth {
5
+ postIssueToken: (scope: string, expires_in?: string) => Promise<ICourierAuthIssueTokenResponse>;
6
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/lib/client.js CHANGED
@@ -42,6 +42,7 @@ var audit_events_1 = require("./audit-events");
42
42
  var automations_1 = require("./automations");
43
43
  var brands_1 = require("./brands");
44
44
  var bulk_1 = require("./bulk");
45
+ var issue_token_1 = require("./issue-token");
45
46
  var lists_1 = require("./lists");
46
47
  var notifications_1 = require("./notifications");
47
48
  var preferences_1 = require("./preferences");
@@ -145,6 +146,7 @@ exports.client = function (options) {
145
146
  getMessages: getMessages(options),
146
147
  getProfile: profile_1.getProfile(options),
147
148
  getRecipientSubscriptions: profile_1.getRecipientSubscriptions(options),
149
+ issueToken: issue_token_1.postIssueToken(options),
148
150
  lists: lists_1.lists(options),
149
151
  mergeProfile: profile_1.mergeProfile(options),
150
152
  notifications: notifications_1.notifications(options),
@@ -0,0 +1,3 @@
1
+ import { ICourierClientConfiguration } from "../types";
2
+ import { ICourierAuthIssueTokenParameters, ICourierAuthIssueTokenResponse } from "./types";
3
+ export declare const postIssueToken: (options: ICourierClientConfiguration) => (params: ICourierAuthIssueTokenParameters) => Promise<ICourierAuthIssueTokenResponse>;
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __generator = (this && this.__generator) || function (thisArg, body) {
12
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
13
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
+ function verb(n) { return function (v) { return step([n, v]); }; }
15
+ function step(op) {
16
+ if (f) throw new TypeError("Generator is already executing.");
17
+ while (_) try {
18
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
19
+ if (y = 0, t) op = [op[0] & 2, t.value];
20
+ switch (op[0]) {
21
+ case 0: case 1: t = op; break;
22
+ case 4: _.label++; return { value: op[1], done: false };
23
+ case 5: _.label++; y = op[1]; op = [0]; continue;
24
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
+ default:
26
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
+ if (t[2]) _.ops.pop();
31
+ _.trys.pop(); continue;
32
+ }
33
+ op = body.call(thisArg, _);
34
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
+ }
37
+ };
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.postIssueToken = void 0;
40
+ exports.postIssueToken = function (options) {
41
+ return function (params) { return __awaiter(void 0, void 0, void 0, function () {
42
+ var res;
43
+ return __generator(this, function (_a) {
44
+ switch (_a.label) {
45
+ case 0: return [4 /*yield*/, options.httpClient.post("/auth/issue-token", {
46
+ expires_in: params.expiresIn,
47
+ scope: params.scope,
48
+ })];
49
+ case 1:
50
+ res = _a.sent();
51
+ return [2 /*return*/, res.data];
52
+ }
53
+ });
54
+ }); };
55
+ };
@@ -0,0 +1,10 @@
1
+ export interface ICourierAuthIssueTokenParameters {
2
+ scope: string;
3
+ expiresIn: string;
4
+ }
5
+ export interface ICourierAuthIssueTokenResponse {
6
+ token?: string;
7
+ }
8
+ export interface ICourierClientAuth {
9
+ postIssueToken: (scope: string, expiresIn?: string) => Promise<ICourierAuthIssueTokenResponse>;
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -164,6 +164,9 @@ interface ElementalBaseNode {
164
164
  if?: string;
165
165
  loop?: string;
166
166
  }
167
+ export interface MessageContext {
168
+ tenant_id?: string;
169
+ }
167
170
  export interface MessageData extends Record<string, any> {
168
171
  }
169
172
  export declare type RuleType = "snooze" | "channel_preferences" | "status";
@@ -240,12 +243,14 @@ export interface AudienceRecipient {
240
243
  }
241
244
  export interface UserRecipient extends UserRecipientType {
242
245
  account_id?: string;
246
+ context?: MessageContext;
243
247
  data?: MessageData;
244
248
  email?: string;
245
249
  locale?: string;
246
250
  user_id?: string;
247
251
  phone_number?: string;
248
252
  preferences?: IProfilePreferences;
253
+ tenant_id?: string;
249
254
  }
250
255
  export declare type Recipient = AudienceRecipient | ListRecipient | ListPatternRecipient | UserRecipient;
251
256
  export declare type MessageRecipient = Recipient | Recipient[];
@@ -268,6 +273,7 @@ export declare type Content = ElementalContentSugar | ElementalContent;
268
273
  export interface BaseMessage {
269
274
  brand_id?: string;
270
275
  channels?: MessageChannels;
276
+ context?: MessageContext;
271
277
  data?: MessageData;
272
278
  metadata?: MessageMetadata;
273
279
  providers?: MessageProviders;
package/lib/types.d.ts CHANGED
@@ -2,6 +2,7 @@ import { ICourierClientAudiences } from "./audiences/types";
2
2
  import { auditEvents } from "./audit-events";
3
3
  import { ICourierClientAutomations } from "./automations/types";
4
4
  import { ICourierClientBulk } from "./bulk/types";
5
+ import { ICourierAuthIssueTokenParameters, ICourierAuthIssueTokenResponse } from "./issue-token/types";
5
6
  import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
6
7
  import { ICourierClientNotifications } from "./notifications/types";
7
8
  import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
@@ -348,5 +349,6 @@ export interface ICourierClient {
348
349
  send: <T extends ICourierSendParameters | ICourierSendMessageParameters>(params: T, config?: ICourierSendConfig) => Promise<SendResponse<T>>;
349
350
  tokenManagement: ReturnType<typeof tokenManagement>;
350
351
  users: ReturnType<typeof users>;
352
+ issueToken: (params: ICourierAuthIssueTokenParameters) => Promise<ICourierAuthIssueTokenResponse>;
351
353
  }
352
354
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trycourier/courier",
3
- "version": "5.0.0",
3
+ "version": "5.2.0",
4
4
  "description": "A node.js module for communicating with the Courier REST API.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",