@trycourier/courier 3.14.1 → 3.16.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [3.16.0]
+
+- adds support for idempotency expiry to be passed in profiles and brands POST
+
+## [3.15.0]
+
+- adds support for audit events
+
 ## [3.14.0]
 
 - adds support for token management

package/lib/audit-events/index.d.ts

@@ -0,0 +1,6 @@
+import { ICourierClientConfiguration } from "../types";
+import { IAuditEvent, ICourierGetAuditEventParams, ICourierListAuditEventsParams, ICourierListAuditEventsResponse } from "./types";
+export declare const auditEvents: (options: ICourierClientConfiguration) => {
+    get: (params: ICourierGetAuditEventParams) => Promise<IAuditEvent>;
+    list: (params: ICourierListAuditEventsParams) => Promise<ICourierListAuditEventsResponse>;
+};

package/lib/audit-events/index.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            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;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.auditEvents = void 0;
+var list = function (options) {
+    return function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.get("/audit-events", {
+                        params: {
+                            cursor: params.cursor
+                        }
+                    })];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var get = function (options) {
+    return function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.get("/audit-events/" + params.auditEventId)];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+exports.auditEvents = function (options) {
+    return {
+        get: get(options),
+        list: list(options)
+    };
+};

package/lib/audit-events/types.d.ts

@@ -0,0 +1,27 @@
+export interface ICourierListAuditEventsParams {
+    cursor?: string;
+}
+export interface ICourierGetAuditEventParams {
+    auditEventId: string;
+}
+export interface ICourierListAuditEventsResponse {
+    paging: {
+        cursor?: string;
+        more: boolean;
+    };
+    results: IAuditEvent[];
+}
+export interface IAuditEvent {
+    actor?: {
+        id?: string;
+        email?: string;
+    };
+    target?: {
+        id?: string;
+        email?: string;
+    };
+    auditEventId: string;
+    source: string;
+    timestamp: string;
+    type: string;
+}

package/lib/audit-events/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/brands.js

@@ -86,6 +86,10 @@ exports.createBrand = function (options) {
                     if (config && config.idempotencyKey) {
                         axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
                     }
+                    if (config && config.idempotencyExpiry) {
+                        axiosConfig.headers["x-idempotency-expiration"] =
+                            config.idempotencyExpiry;
+                    }
                     return [4 /*yield*/, options.httpClient.post("/brands", params, axiosConfig)];
                 case 1:
                     res = _a.sent();

package/lib/client.js

@@ -38,6 +38,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.client = void 0;
 var audiences_1 = require("./audiences");
+var audit_events_1 = require("./audit-events");
 var automations_1 = require("./automations");
 var brands_1 = require("./brands");
 var bulk_1 = require("./bulk");
@@ -114,6 +115,7 @@ exports.client = function (options) {
     return {
         addRecipientToLists: profile_1.addRecipientToLists(options),
         audiences: audiences_1.audiences(options),
+        auditEvents: audit_events_1.auditEvents(options),
         automations: automations_1.automations(options),
         bulk: bulk_1.bulk(options),
         createBrand: brands_1.createBrand(options),

package/lib/profile.js

@@ -64,6 +64,10 @@ exports.mergeProfile = function (options) {
                     if (config && config.idempotencyKey) {
                         axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
                     }
+                    if (config && config.idempotencyExpiry) {
+                        axiosConfig.headers["x-idempotency-expiration"] =
+                            config.idempotencyExpiry;
+                    }
                     return [4 /*yield*/, options.httpClient.post("/profiles/" + params.recipientId, {
                             profile: params.profile
                         }, axiosConfig)];

package/lib/types.d.ts

@@ -1,5 +1,6 @@
 import { AxiosRequestConfig } from "axios";
 import { ICourierClientAudiences } from "./audiences/types";
+import { auditEvents } from "./audit-events";
 import { ICourierClientAutomations } from "./automations/types";
 import { ICourierClientBulk } from "./bulk/types";
 import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
@@ -80,6 +81,7 @@ export interface ICourierProfileListsPostParameters {
 }
 export interface ICourierProfilePostConfig {
     idempotencyKey?: string;
+    idempotencyExpiry?: number;
 }
 export interface ICourierProfilePostResponse {
     status: "SUCCESS";
@@ -277,6 +279,7 @@ export interface ICourierBrandParameters {
 }
 export interface ICourierBrandPostConfig {
     idempotencyKey?: string;
+    idempotencyExpiry?: number;
 }
 export interface ICourierBrandPutParameters extends ICourierBrandParameters {
     id: string;
@@ -289,6 +292,7 @@ export declare type SendResponse<T extends ICourierSendParameters | ICourierSend
 export interface ICourierClient {
     addRecipientToLists: (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
     audiences: ICourierClientAudiences;
+    auditEvents: ReturnType<typeof auditEvents>;
     automations: ICourierClientAutomations;
     bulk: ICourierClientBulk;
     createBrand: (params: ICourierBrandParameters, config?: ICourierBrandPostConfig) => Promise<ICourierBrand>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "3.14.1",
+  "version": "3.16.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",