@trycourier/courier - npm Package Compare versions

Comparing version 3.2.1 to 3.3.0

CHANGELOG.md

@@ -8,2 +8,6 @@ # Change Log
 
+## [v3.3.0] - 2022-01-25
+
+- adds support for bulk processing endpoints
+
 ## [v3.2.1] - 2022-01-13
@@ -193,3 +197,4 @@
 
-[unreleased]: https://github.com/trycourier/courier-node/compare/v3.2.1...HEAD
+[unreleased]: https://github.com/trycourier/courier-node/compare/v3.3.0...HEAD
+[v3.3.0]: https://github.com/trycourier/courier-node/compare/v3.2.1...v3.3.0
 [v3.2.1]: https://github.com/trycourier/courier-node/compare/v3.2.0...v3.2.1
@@ -196,0 +201,0 @@ [v3.2.0]: https://github.com/trycourier/courier-node/compare/v3.1.0...v3.2.0

lib/client.js

@@ -42,2 +42,3 @@ "use strict";
 var brands_1 = require("./brands");
+var bulk_1 = require("./bulk");
 var lists_1 = require("./lists");
@@ -145,2 +146,3 @@ var notifications_1 = require("./notifications");
         automations: automations_1.automations(options),
+        bulk: bulk_1.bulk(options),
         createBrand: brands_1.createBrand(options),
@@ -147,0 +149,0 @@ deleteBrand: brands_1.deleteBrand(options),

lib/types.d.ts

 import { AxiosRequestConfig } from "axios";
 import { ICourierClientAutomations } from "./automations/types";
+import { ICourierClientBulk } from "./bulk/types";
 import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
@@ -276,2 +277,3 @@ import { ICourierClientNotifications } from "./notifications/types";
     automations: ICourierClientAutomations;
+    bulk: ICourierClientBulk;
     createBrand: (params: ICourierBrandParameters, config?: ICourierBrandPostConfig) => Promise<ICourierBrand>;
@@ -278,0 +280,0 @@ deleteBrand: (brandId: string) => Promise<void>;

package.json

 {
   "name": "@trycourier/courier",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "A node.js module for communicating with the Courier REST API.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -380,2 +380,41 @@ [![Courier: Your Complete Communication Stack](https://marketing-assets-public.s3.us-west-1.amazonaws.com/github_nodejs.png)](https://courier.com)
   await courier.notifications.cancelSubmission("notification1", "submission1");
+
+  // Bulk Processing
+  // Example: create a job
+  const response = await courier.bulk.createJob({
+    message: {
+      event: "RR4NDQ7NZ24A8TKPWVBEDGE15E9A",
+    },
+  });
+  console.log(response);
+
+  // Example: get a job
+  const response = await courier.bulk.getJob({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+  });
+  console.log(response);
+
+  // Example: Ingest users in a job
+  const response = await courier.bulk.ingestUsers({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+    users: [
+      {
+        profile: {
+          email: "[e-mail]",
+        },
+      },
+    ],
+  });
+  console.log(response);
+
+  // Example: Run a job
+  await courier.bulk.runJob({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+  });
+
+  // Example: Get user details in a job
+  const response = await courier.bulk.getJobUsers({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+  });
+  console.log(response);
 }
@@ -382,0 +421,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

104731

increased by11.71%

Number of package files

34

increased by13.33%

Lines of code

1875

increased by14.61%

Number of lines in readme file

465

increased by9.15%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes