@types/sparkpost - npm Package Compare versions

Comparing version 1.3.6 to 1.3.7

sparkpost v1.3/index.d.ts

@@ -9,4 +9,4 @@ // Type definitions for sparkpost v1.3
 
+import * as Http from "http";
 import * as Request from "request";
-import * as Http from "http";
 
@@ -47,3 +47,6 @@ declare class SparkPost {
          */
-        search(parameters: SparkPost.MessageEventParameters, callback: SparkPost.ResultsCallback<SparkPost.MessageEvent[]>): void;
+        search(
+            parameters: SparkPost.MessageEventParameters,
+            callback: SparkPost.ResultsCallback<SparkPost.MessageEvent[]>,
+        ): void;
     };
@@ -64,3 +67,6 @@ /** A recipient list is a collection of recipients that can be used in a transmission. */
          */
-        find(options: { id: string, show_recipients?: false | undefined }, callback: SparkPost.Callback<SparkPost.RecipientList>): void;
+        find(
+            options: { id: string; show_recipients?: false | undefined },
+            callback: SparkPost.Callback<SparkPost.RecipientList>,
+        ): void;
         /**
@@ -72,3 +78,6 @@ * Retrieve details about a specified recipient list by specifying its id in the URI path.
          */
-        find(options: { id: string, show_recipients: true }, callback: SparkPost.Callback<SparkPost.RecipientListWithRecipients>): void;
+        find(
+            options: { id: string; show_recipients: true },
+            callback: SparkPost.Callback<SparkPost.RecipientListWithRecipients>,
+        ): void;
         /**
@@ -82,3 +91,6 @@ * Create a recipient list by providing a recipient list object as the POST request body.
          */
-        create(options: SparkPost.CreateRecipientList, callback: SparkPost.ResultsCallback<SparkPost.RecipientListMetadata>): void;
+        create(
+            options: SparkPost.CreateRecipientList,
+            callback: SparkPost.ResultsCallback<SparkPost.RecipientListMetadata>,
+        ): void;
         /**
@@ -90,3 +102,6 @@ * Update an existing recipient list by specifying its ID in the URI path and use a recipient list object as the PUT request body.
          */
-        update(options: SparkPost.UpdateRecipientList, callback: SparkPost.ResultsCallback<SparkPost.RecipientListMetadata>): void;
+        update(
+            options: SparkPost.UpdateRecipientList,
+            callback: SparkPost.ResultsCallback<SparkPost.RecipientListMetadata>,
+        ): void;
         /**
@@ -123,3 +138,6 @@ * Permanently delete the specified recipient list.
          */
-        update(options: SparkPost.UpdateRelayWebhook & { relayWebhookId: string }, callback: SparkPost.ResultsCallback<{ id: string }>): void;
+        update(
+            options: SparkPost.UpdateRelayWebhook & { relayWebhookId: string },
+            callback: SparkPost.ResultsCallback<{ id: string }>,
+        ): void;
         /**
@@ -149,3 +167,6 @@ * Delete a relay webhook by specifying the webhook ID in the URI path.
          */
-        create(options: SparkPost.CreateSendingDomain, callback: SparkPost.ResultsCallback<{ message: string, domain: string }>): void;
+        create(
+            options: SparkPost.CreateSendingDomain,
+            callback: SparkPost.ResultsCallback<{ message: string; domain: string }>,
+        ): void;
         /**
@@ -156,3 +177,6 @@ * Update the attributes of an existing sending domain by specifying its domain name in the URI path and use a sending domain object as the PUT request body.
          */
-        update(options: SparkPost.UpdateSendingDomain, callback: SparkPost.ResultsCallback<{ message: string, domain: string }>): void;
+        update(
+            options: SparkPost.UpdateSendingDomain,
+            callback: SparkPost.ResultsCallback<{ message: string; domain: string }>,
+        ): void;
         /**
@@ -179,3 +203,2 @@ * Delete an existing sending domain.
         /**
-         *
          * @param subaccountId The webhook id
@@ -190,3 +213,6 @@ * @param callback The request callback with subaccount information results
          */
-        create(options: SparkPost.CreateSubaccount, callback: SparkPost.ResultsCallback<SparkPost.CreateSubaccountResponse>): void;
+        create(
+            options: SparkPost.CreateSubaccount,
+            callback: SparkPost.ResultsCallback<SparkPost.CreateSubaccountResponse>,
+        ): void;
         /**
@@ -205,3 +231,6 @@ * Update an existing subaccount’s information.
          */
-        search(parameters: SparkPost.SupressionSearch, callback: SparkPost.ResultsCallback<SparkPost.SupressionListEntry[]>): void;
+        search(
+            parameters: SparkPost.SupressionSearch,
+            callback: SparkPost.ResultsCallback<SparkPost.SupressionListEntry[]>,
+        ): void;
         /**
@@ -224,3 +253,6 @@ * Retrieve the suppression status for a specific recipient by specifying the recipient’s email address in the URI path.
          */
-        upsert(parameters: SparkPost.CreateSupressionListEntry | SparkPost.CreateSupressionListEntry[], callback: SparkPost.ResultsCallback<{ message: string }>): void;
+        upsert(
+            parameters: SparkPost.CreateSupressionListEntry | SparkPost.CreateSupressionListEntry[],
+            callback: SparkPost.ResultsCallback<{ message: string }>,
+        ): void;
     };
@@ -238,3 +270,6 @@ templates: {
          */
-        find(options: { id: string, draft?: boolean | undefined }, callback: SparkPost.ResultsCallback<SparkPost.Template>): void;
+        find(
+            options: { id: string; draft?: boolean | undefined },
+            callback: SparkPost.ResultsCallback<SparkPost.Template>,
+        ): void;
         /**
@@ -245,3 +280,6 @@ * Create a new template
          */
-        create(options: { template: SparkPost.CreateTemplate }, callback: SparkPost.ResultsCallback<{ id: string }>): void;
+        create(
+            options: { template: SparkPost.CreateTemplate },
+            callback: SparkPost.ResultsCallback<{ id: string }>,
+        ): void;
         /**
@@ -253,4 +291,4 @@ * Update an existing template
         update(options: {
-            id: string,
-            template: SparkPost.UpdateTemplate,
+            id: string;
+            template: SparkPost.UpdateTemplate;
             update_published?: boolean | undefined;
@@ -269,3 +307,6 @@ }, callback: SparkPost.ResultsCallback<{ id: string }>): void;
          */
-        preview(options: { id: string, data: any, draft?: boolean | undefined }, callback: SparkPost.ResultsCallback<SparkPost.TemplateContent>): void;
+        preview(
+            options: { id: string; data: any; draft?: boolean | undefined },
+            callback: SparkPost.ResultsCallback<SparkPost.TemplateContent>,
+        ): void;
     };
@@ -283,3 +324,6 @@ transmissions: {
          */
-        all(options: { campaign_id?: string | undefined, template_id?: string | undefined }, callback: SparkPost.ResultsCallback<SparkPost.TransmissionSummary[]>): void;
+        all(
+            options: { campaign_id?: string | undefined; template_id?: string | undefined },
+            callback: SparkPost.ResultsCallback<SparkPost.TransmissionSummary[]>,
+        ): void;
         /**
@@ -296,7 +340,10 @@ * Retrieve the details about a transmission by its ID
          */
-        send(options: { transmissionBody: SparkPost.CreateTransmission, num_rcpt_errors?: number | undefined }, callback: SparkPost.ResultsCallback<{
-            total_rejected_recipients: number;
-            total_accepted_recipients: number;
-            id: string;
-        }>): void;
+        send(
+            options: { transmissionBody: SparkPost.CreateTransmission; num_rcpt_errors?: number | undefined },
+            callback: SparkPost.ResultsCallback<{
+                total_rejected_recipients: number;
+                total_accepted_recipients: number;
+                id: string;
+            }>,
+        ): void;
     };
@@ -314,3 +361,6 @@ webhooks: {
          */
-        all(options: { timezone?: string | undefined }, callback: SparkPost.ResultsCallback<Array<SparkPost.WebhookLinks & SparkPost.Webhook>>): void;
+        all(
+            options: { timezone?: string | undefined },
+            callback: SparkPost.ResultsCallback<Array<SparkPost.WebhookLinks & SparkPost.Webhook>>,
+        ): void;
         /**
@@ -321,3 +371,6 @@ * Retrieve details about a specified webhook by its id
          */
-        describe(options: { id: string, timezone?: string | undefined }, callback: SparkPost.ResultsCallback<SparkPost.WebhookLinks & SparkPost.Webhook>): void;
+        describe(
+            options: { id: string; timezone?: string | undefined },
+            callback: SparkPost.ResultsCallback<SparkPost.WebhookLinks & SparkPost.Webhook>,
+        ): void;
         /**
@@ -328,3 +381,6 @@ * Create a new webhook
          */
-        create(options: SparkPost.Webhook, callback: SparkPost.ResultsCallback<SparkPost.WebhookLinks & { id: string }>): void;
+        create(
+            options: SparkPost.Webhook,
+            callback: SparkPost.ResultsCallback<SparkPost.WebhookLinks & { id: string }>,
+        ): void;
         /**
@@ -335,3 +391,6 @@ * Update an existing webhook
          */
-        update(options: SparkPost.UpdateWebhook, callback: SparkPost.ResultsCallback<SparkPost.WebhookLinks & { id: string }>): void;
+        update(
+            options: SparkPost.UpdateWebhook,
+            callback: SparkPost.ResultsCallback<SparkPost.WebhookLinks & { id: string }>,
+        ): void;
         /**
@@ -348,10 +407,13 @@ * Delete an existing webhook
          */
-        validate(options: { id: string, message: any }, callback: SparkPost.ResultsCallback<{
-            msg: string;
-            response: {
-                status: number;
-                headers: any;
-                body: string;
-            }
-        }>): void;
+        validate(
+            options: { id: string; message: any },
+            callback: SparkPost.ResultsCallback<{
+                msg: string;
+                response: {
+                    status: number;
+                    headers: any;
+                    body: string;
+                };
+            }>,
+        ): void;
         /**
@@ -362,8 +424,11 @@ * Sends an example message event batch from the Webhook API to the target URL
          */
-        getBatchStatus(options: { id: string, limit?: number | undefined }, callback: SparkPost.ResultsCallback<{
-            batch_id: string;
-            ts: string;
-            attempts: number;
-            response_code: number;
-        }[]>): void;
+        getBatchStatus(
+            options: { id: string; limit?: number | undefined },
+            callback: SparkPost.ResultsCallback<{
+                batch_id: string;
+                ts: string;
+                attempts: number;
+                response_code: number;
+            }[]>,
+        ): void;
         /**
@@ -402,3 +467,2 @@ * Lists descriptions of the events, event types, and event fields that could be included in a Webhooks post to your target URL.
 declare namespace SparkPost {
-
     export interface ErrorWithDescription {
@@ -887,3 +951,2 @@ message: string;
          * After a template has been created, this property cannot be changed. Maximum length - 64 bytes
-         *
          */
@@ -912,3 +975,2 @@ id: string;
          * After a template has been created, this property cannot be changed. Maximum length - 64 bytes
-         *
          */
@@ -975,3 +1037,5 @@ id?: string | undefined;
         /** Content that will be used to construct a message */
-        content: InlineContent | { template_id: string, use_draft_template?: boolean | undefined } | { email_rfc822: string };
+        content: InlineContent | { template_id: string; use_draft_template?: boolean | undefined } | {
+            email_rfc822: string;
+        };
     }
@@ -1008,3 +1072,5 @@
         /** Content that will be used to construct a message */
-        content: InlineContent | { template_id: string, use_draft_template?: boolean | undefined } | { email_rfc822: string };
+        content: InlineContent | { template_id: string; use_draft_template?: boolean | undefined } | {
+            email_rfc822: string;
+        };
         /** Computed total number of messages generated */
@@ -1049,3 +1115,3 @@ num_generated: number;
         /** "[e-mail]" or JSON object composed of the “name” and “email” fields “from” : { “name” : “My Company”, “email” : "[e-mail]" } used to compose the email’s “From” header */
-        from?: string | { email: string, name: string } | undefined;
+        from?: string | { email: string; name: string } | undefined;
         /** Email address used to compose the email’s “Reply-To” header */
@@ -1052,0 +1118,0 @@ reply_to?: string | undefined;

sparkpost v1.3/package.json

 {
     "name": "@types/sparkpost",
-    "version": "1.3.6",
+    "version": "1.3.7",
     "description": "TypeScript definitions for sparkpost",
@@ -26,4 +26,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sparkpost",
     },
-    "typesPublisherContentHash": "03b8e4f4821fb5c0d9ae9e8d4c3963c29f67d9827528956cfdd50fbba8d5195b",
-    "typeScriptVersion": "4.3"
+    "typesPublisherContentHash": "b896e4ab466264b0eaa45c3a43f068d1a7ba32bef1acbc89ec2b760f92e923e5",
+    "typeScriptVersion": "4.5"
 }

sparkpost v1.3/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Thu, 25 May 2023 20:34:44 GMT
+ * Last updated: Mon, 25 Sep 2023 13:39:06 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/request](https://npmjs.com/package/@types/request)
@@ -14,0 +14,0 @@ * Global values: none

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

57924

1.48%

Lines of code

1111

6.42%

No dependency changes