@trycourier/courier 4.0.1 → 4.1.0

package/README.md

@@ -16,6 +16,12 @@ npm install @trycourier/courier
 
 You will need to get a Courier API key to get started. You can sign up and create one for free at [courier.com](https://courier.com).
 
+## Upgrade Guides
+
+### v3 to v4
+
+v4 uses native fetch client to make requests or falls back to a polyfill if the client doesn't exist in the environment it's running in. Check [Error Handling](#Error-Handling) out.
+
 ## Getting Started
 
 ```javascript
@@ -680,12 +686,12 @@ All network related promise rejections are not handled in any way. All successfu
 
 `CourierHttpClientError` extends native `Error` interface with two extra properties:
 
-* `response`: this is the `fetch` response as is
-* `data`: this is the parsed body of the response
+- `response`: this is the `fetch` response as is
+- `data`: this is the parsed body of the response
 
 ```javascript
 // Error handling example
-import { CourierClient, CourierHttpClientError } from '@trycourier/courier';
+import { CourierClient, CourierHttpClientError } from "@trycourier/courier";
 
 const courier = CourierClient();
 
@@ -697,7 +703,9 @@ try {
     console.log("The Courier response is:", error.data);
     console.log("The error message is:", error.message);
   } else {
-    console.log('There was a problem making that request. Make sure you are online.');
+    console.log(
+      "There was a problem making that request. Make sure you are online."
+    );
   }
 }
 ```

package/lib/automations/types.d.ts

@@ -1,6 +1,13 @@
 import { Message } from "../send/types";
-export declare type AutomationStepAction = "cancel" | "delay" | "send" | "send-list" | "update-profile";
+export declare type AutomationStepAction = "cancel" | "delay" | "invoke" | "send" | "send-list" | "update-profile";
 export declare type MergeAlgorithm = "replace" | "none" | "overwrite" | "soft-merge";
+export interface IAutomationRunContext {
+    brand?: string;
+    data?: any;
+    profile?: any;
+    template?: string;
+    recipient?: string;
+}
 export interface IAutomationStep {
     action: AutomationStepAction;
     if?: string;
@@ -15,6 +22,13 @@ export interface IAutomationDelayStep extends IAutomationStep {
     duration?: string;
     until?: string;
 }
+export interface IAutomationInvokeStep extends IAutomationStep {
+    action: "invoke";
+    context?: IAutomationRunContext;
+    template: string;
+    if?: string;
+    ref?: string;
+}
 export interface IAutomationSendStep extends IAutomationStep {
     action: "send";
     brand?: string;
@@ -42,7 +56,7 @@ export interface IAutomationUpdateProfileStep extends IAutomationStep {
     profile: object;
     merge: MergeAlgorithm;
 }
-export declare type AutomationStep = IAutomationCancelStep | IAutomationDelayStep | IAutomationSendStep | IAutomationV2SendStep | IAutomationSendListStep | IAutomationUpdateProfileStep;
+export declare type AutomationStep = IAutomationCancelStep | IAutomationDelayStep | IAutomationInvokeStep | IAutomationSendStep | IAutomationV2SendStep | IAutomationSendListStep | IAutomationUpdateProfileStep;
 export interface IAutomation {
     cancelation_token?: string;
     steps: AutomationStep[];

package/lib/http-client.js

@@ -93,7 +93,7 @@ exports.initHttpClient = function (_a) {
                         case 0:
                             searchParams = String(new URLSearchParams(config === null || config === void 0 ? void 0 : config.params));
                             searchQueryString = searchParams && "?" + searchParams;
-                            fullUrl = String(new URL("" + url + searchQueryString, baseUrl));
+                            fullUrl = encodeURI("" + (baseUrl !== null && baseUrl !== void 0 ? baseUrl : '') + url + searchQueryString);
                             contentTypeHeader = body == null ? null : { "Content-Type": "application/json" };
                             idempotencyKeyHeader = (config === null || config === void 0 ? void 0 : config.idempotencyKey) ? { "Idempotency-Key": config.idempotencyKey }
                                 : null;

package/package.json

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