postmark - npm Package Compare versions

Comparing version 2.5.6 to 2.6.0

dist/client/models/client/ClientOptions.d.ts

@@ -14,3 +14,4 @@ export declare namespace ClientOptions {
         OPTIONS = "OPTIONS",
-        HEAD = "HEAD"
+        HEAD = "HEAD",
+        PATCH = "PATCH"
     }
@@ -17,0 +18,0 @@ enum DefaultHeaderNames {

dist/client/models/client/ClientOptions.js

@@ -22,2 +22,3 @@ "use strict";
         HttpMethod["HEAD"] = "HEAD";
+        HttpMethod["PATCH"] = "PATCH";
     })(HttpMethod = ClientOptions.HttpMethod || (ClientOptions.HttpMethod = {}));
@@ -24,0 +25,0 @@ var DefaultHeaderNames;

dist/client/models/index.d.ts

@@ -27,1 +27,3 @@ export * from "./client/ClientOptions";
 export * from "./suppressions/Suppression";
+export * from "./streams/MessageStream";
+export * from "./streams/MessageStreamsFilteringParameters";

dist/client/models/index.js

@@ -21,2 +21,4 @@ "use strict";
 __export(require("./webhooks/WebhookFilteringParameters"));
+__export(require("./streams/MessageStream"));
+__export(require("./streams/MessageStreamsFilteringParameters"));
 //# sourceMappingURL=index.js.map

dist/client/ServerClient.d.ts

 import BaseClient from "./BaseClient";
 import { Callback, ClientOptions, DefaultResponse, FilteringParameters } from "./models/index";
-import { Bounce, BounceActivationResponse, BounceCounts, BounceDump, BounceFilteringParameters, Bounces, BrowserUsageCounts, ClickCounts, ClickLocationCounts, ClickPlaformUsageCounts, CreateInboundRuleRequest, CreateSuppressionsRequest, CreateTemplateRequest, CreateWebhookRequest, DeleteSuppressionsRequest, DeliveryStatistics, EmailClientUsageCounts, EmailPlaformUsageCounts, EmailReadTimesCounts, InboundMessageDetails, InboundMessages, InboundMessagesFilteringParameters, InboundRule, InboundRules, Message, MessageSendingResponse, OpenCounts, OutboundMessageClicks, OutboundMessageClicksFilteringParameters, OutboundMessageDetails, OutboundMessageDump, OutboundMessageOpens, OutboundMessageOpensFilteringParameters, OutboundMessages, OutboundMessagesFilteringParameters, OutboundStatistics, SentCounts, Server, SpamCounts, StatisticsFilteringParameters, Suppressions, SuppressionStatuses, Template, TemplatedMessage, TemplateFilteringParameters, Templates, TemplateValidation, TemplateValidationOptions, TrackedEmailCounts, UpdateServerRequest, UpdateTemplateRequest, UpdateWebhookRequest, Webhook, WebhookFilteringParameters, Webhooks } from "./models/index";
+import { Bounce, BounceActivationResponse, BounceCounts, BounceDump, BounceFilteringParameters, Bounces, BrowserUsageCounts, ClickCounts, ClickLocationCounts, ClickPlaformUsageCounts, CreateInboundRuleRequest, CreateMessageStreamRequest, CreateSuppressionsRequest, CreateTemplateRequest, CreateWebhookRequest, DeleteSuppressionsRequest, DeliveryStatistics, EmailClientUsageCounts, EmailPlaformUsageCounts, EmailReadTimesCounts, InboundMessageDetails, InboundMessages, InboundMessagesFilteringParameters, InboundRule, InboundRules, Message, MessageSendingResponse, MessageStream, MessageStreamArchiveResponse, MessageStreams, MessageStreamsFilteringParameters, MessageStreamUnarchiveResponse, OpenCounts, OutboundMessageClicks, OutboundMessageClicksFilteringParameters, OutboundMessageDetails, OutboundMessageDump, OutboundMessageOpens, OutboundMessageOpensFilteringParameters, OutboundMessages, OutboundMessagesFilteringParameters, OutboundStatistics, SentCounts, Server, SpamCounts, StatisticsFilteringParameters, Suppressions, SuppressionStatuses, Template, TemplatedMessage, TemplateFilteringParameters, Templates, TemplateValidation, TemplateValidationOptions, TrackedEmailCounts, UpdateMessageStreamRequest, UpdateServerRequest, UpdateTemplateRequest, UpdateWebhookRequest, Webhook, WebhookFilteringParameters, Webhooks } from "./models/index";
 /**
@@ -408,2 +408,50 @@ * Server client class that can be used to interact with an individual Postmark Server.
     /**
+     * Get the list of message streams on a server.
+     *
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    getMessageStreams(filter?: MessageStreamsFilteringParameters, callback?: Callback<MessageStreams>): Promise<MessageStreams>;
+    /**
+     * Get details for a specific message stream on a server.
+     *
+     * @param id - The ID of the message stream you wish to retrieve.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    getMessageStream(id: string, callback?: Callback<MessageStream>): Promise<MessageStream>;
+    /**
+     * Update message stream on the associated server.
+     *
+     * @param id - Id of the webhook you wish to update.
+     * @param options - Webhook options you wish to update.
+     * @param callback If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    editMessageStream(id: string, options: UpdateMessageStreamRequest, callback?: Callback<MessageStream>): Promise<MessageStream>;
+    /**
+     * Create a message stream on the associated server.
+     *
+     * @param options - Configuration options to be used when creating message stream on the server.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    createMessageStream(options: CreateMessageStreamRequest, callback?: Callback<MessageStream>): Promise<MessageStream>;
+    /**
+     * Archive a message stream on the associated server.
+     *
+     * @param options - Configuration options to be used when creating message stream on the server.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    archiveMessageStream(id: string, callback?: Callback<MessageStreamArchiveResponse>): Promise<MessageStreamArchiveResponse>;
+    /**
+     * Unrchive a message stream on the associated server.
+     *
+     * @param options - Configuration options to be used when creating message stream on the server.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    unarchiveMessageStream(id: string, callback?: Callback<MessageStreamUnarchiveResponse>): Promise<MessageStreamUnarchiveResponse>;
+    /**
      * Get the list of suppressions for a message stream on a server.
@@ -410,0 +458,0 @@ *

dist/client/ServerClient.js

@@ -553,2 +553,63 @@ "use strict";
     /**
+     * Get the list of message streams on a server.
+     *
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    ServerClient.prototype.getMessageStreams = function (filter, callback) {
+        if (filter === void 0) { filter = {}; }
+        return this.processRequestWithoutBody(index_1.ClientOptions.HttpMethod.GET, "/message-streams", filter, callback);
+    };
+    /**
+     * Get details for a specific message stream on a server.
+     *
+     * @param id - The ID of the message stream you wish to retrieve.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    ServerClient.prototype.getMessageStream = function (id, callback) {
+        return this.processRequestWithoutBody(index_1.ClientOptions.HttpMethod.GET, "/message-streams/" + id, {}, callback);
+    };
+    /**
+     * Update message stream on the associated server.
+     *
+     * @param id - Id of the webhook you wish to update.
+     * @param options - Webhook options you wish to update.
+     * @param callback If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    ServerClient.prototype.editMessageStream = function (id, options, callback) {
+        return this.processRequestWithBody(index_1.ClientOptions.HttpMethod.PATCH, "/message-streams/" + id, options, callback);
+    };
+    /**
+     * Create a message stream on the associated server.
+     *
+     * @param options - Configuration options to be used when creating message stream on the server.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    ServerClient.prototype.createMessageStream = function (options, callback) {
+        return this.processRequestWithBody(index_1.ClientOptions.HttpMethod.POST, "/message-streams", options, callback);
+    };
+    /**
+     * Archive a message stream on the associated server.
+     *
+     * @param options - Configuration options to be used when creating message stream on the server.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    ServerClient.prototype.archiveMessageStream = function (id, callback) {
+        return this.processRequestWithBody(index_1.ClientOptions.HttpMethod.POST, "/message-streams/" + id + "/archive", {}, callback);
+    };
+    /**
+     * Unrchive a message stream on the associated server.
+     *
+     * @param options - Configuration options to be used when creating message stream on the server.
+     * @param callback - If the callback is provided, it will be passed to the resulting promise as a continuation.
+     * @returns A promise that will complete when the API responds (or an error occurs).
+     */
+    ServerClient.prototype.unarchiveMessageStream = function (id, callback) {
+        return this.processRequestWithBody(index_1.ClientOptions.HttpMethod.POST, "/message-streams/" + id + "/unarchive", {}, callback);
+    };
+    /**
      * Get the list of suppressions for a message stream on a server.
@@ -555,0 +616,0 @@ *

package.json

@@ -12,3 +12,3 @@ {
   ],
-  "version": "2.5.6",
+  "version": "2.6.0",
   "author": "Igor Balos",
@@ -15,0 +15,0 @@ "contributors": [

RELEASE.md

@@ -9,2 +9,8 @@ <a href="https://postmarkapp.com">
 
+Pre-release recommendations:
+
+* Make sure to check if there are any styling or code errors by running lint tools defined in package.json
+
+Release steps:
+
 1. Merge your branch to master
@@ -11,0 +17,0 @@ 2. Update version in package.json

SECURITY.md

@@ -5,3 +5,3 @@ # Security Policy
 
-We try to apply security updates as fast as possible and we support Node.JS which can be found [here](https://github.com/wildbit/postmark.js/blob/master/.travis.yml).
+We try to apply security updates as fast as possible and we support Node.JS versions from the list [here](https://github.com/wildbit/postmark.js/blob/master/.travis.yml).
 
@@ -8,0 +8,0 @@ ## Reporting a Vulnerability

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

281068

increased by5.91%

Number of package files

141

increased by5.22%

Lines of code

4964

increased by5.68%

No dependency changes