svix - npm Package Compare versions

Comparing version 1.56.1-next-6676cce4085df5e19ee14cdbdc7fa02ec0f3939c.0 to 1.56.1-next-c875ff370e68aad779ff0b24d5fdc553f5c4a5c2.0

dist/api/authentication.d.ts

@@ -7,5 +7,5 @@ import { Configuration, AppPortalAccessIn, AppPortalAccessOut, ApplicationTokenExpireIn, DashboardAccessOut } from "../openapi";
     appPortalAccess(appId: string, appPortalAccessIn: AppPortalAccessIn, options?: PostOptions): Promise<AppPortalAccessOut>;
+    expireAll(appId: string, applicationTokenExpireIn: ApplicationTokenExpireIn, options?: PostOptions): Promise<void>;
     dashboardAccess(appId: string, options?: PostOptions): Promise<DashboardAccessOut>;
-    expireAll(appId: string, applicationTokenExpireIn: ApplicationTokenExpireIn, options?: PostOptions): Promise<void>;
     logout(options?: PostOptions): Promise<void>;
 }

dist/api/authentication.js

@@ -13,5 +13,2 @@ "use strict";
     }
-    dashboardAccess(appId, options) {
-        return this.api.v1AuthenticationDashboardAccess(Object.assign({ appId }, options));
-    }
     expireAll(appId, applicationTokenExpireIn, options) {
@@ -21,2 +18,5 @@ return this.api.v1AuthenticationExpireAll(Object.assign({ appId,
     }
+    dashboardAccess(appId, options) {
+        return this.api.v1AuthenticationDashboardAccess(Object.assign({ appId }, options));
+    }
     logout(options) {
@@ -23,0 +23,0 @@ return this.api.v1AuthenticationLogout(Object.assign({}, options));

dist/api/background_task.d.ts

@@ -1,7 +0,8 @@
-import { Configuration, BackgroundTaskStatus, BackgroundTaskType, BackgroundTaskOut, ListResponseBackgroundTaskOut } from "../openapi";
+import { Configuration, BackgroundTaskOut, BackgroundTaskStatus, BackgroundTaskType, ListResponseBackgroundTaskOut, Ordering } from "../openapi";
 export interface BackgroundTaskListOptions {
-    iterator?: string | null;
-    limit?: number;
     status?: BackgroundTaskStatus;
     task?: BackgroundTaskType;
+    limit?: number;
+    iterator?: string | null;
+    order?: Ordering;
 }
@@ -11,4 +12,5 @@ export declare class BackgroundTask {
     constructor(config: Configuration);
+    list(options?: BackgroundTaskListOptions): Promise<ListResponseBackgroundTaskOut>;
     listByEndpoint(options?: BackgroundTaskListOptions): Promise<ListResponseBackgroundTaskOut>;
     get(taskId: string): Promise<BackgroundTaskOut>;
 }

dist/api/background_task.js

@@ -9,7 +9,9 @@ "use strict";
     }
-    listByEndpoint(options) {
+    list(options) {
         var _a;
-        const iterator = (_a = options === null || options === void 0 ? void 0 : options.iterator) !== null && _a !== void 0 ? _a : undefined;
-        return this.api.listBackgroundTasks(Object.assign(Object.assign({}, options), { iterator }));
+        return this.api.listBackgroundTasks(Object.assign(Object.assign({}, options), { iterator: (_a = options === null || options === void 0 ? void 0 : options.iterator) !== null && _a !== void 0 ? _a : undefined }));
     }
+    listByEndpoint(options) {
+        return this.list(options);
+    }
     get(taskId) {
@@ -16,0 +18,0 @@ return this.api.getBackgroundTask({

dist/api/event_type.d.ts

@@ -10,2 +10,5 @@ import { Configuration, EventTypeImportOpenApiIn, EventTypeImportOpenApiOut, EventTypeIn, EventTypeOut, EventTypePatch, EventTypeUpdate, ListResponseEventTypeOut, Ordering } from "../openapi";
 }
+export interface EventTypeDeleteOptions {
+    expunge?: boolean;
+}
 export declare class EventType {
@@ -19,4 +22,4 @@ private readonly api;
     update(eventTypeName: string, eventTypeUpdate: EventTypeUpdate): Promise<EventTypeOut>;
-    delete(eventTypeName: string): Promise<void>;
+    delete(eventTypeName: string, options?: EventTypeDeleteOptions): Promise<void>;
     patch(eventTypeName: string, eventTypePatch: EventTypePatch): Promise<EventTypeOut>;
 }

dist/api/event_type.js

@@ -30,6 +30,4 @@ "use strict";
     }
-    delete(eventTypeName) {
-        return this.api.v1EventTypeDelete({
-            eventTypeName,
-        });
+    delete(eventTypeName, options) {
+        return this.api.v1EventTypeDelete(Object.assign({ eventTypeName }, options));
     }
@@ -36,0 +34,0 @@ patch(eventTypeName, eventTypePatch) {

dist/api/integration.js

@@ -38,4 +38,4 @@ "use strict";
         return this.api.v1IntegrationGetKey({
+            appId,
             integId,
-            appId,
         });
@@ -42,0 +42,0 @@ }

dist/index.d.ts

@@ -10,3 +10,3 @@ import { Configuration } from "./openapi";
 import { MessageAttempt } from "./api/message_attempt";
-import { OperationalWebhookEndpoint } from "./api/op_webhook_endpoint";
+import { OperationalWebhookEndpoint } from "./api/operational_webhook_endpoint";
 import { Statistics } from "./api/statistics";
@@ -24,3 +24,3 @@ export * from "./openapi/models/all";
 export { MessageAttemptListByEndpointOptions, MessageAttemptListOptions, } from "./api/message_attempt";
-export { OperationalWebhookEndpointListOptions } from "./api/op_webhook_endpoint";
+export { OperationalWebhookEndpointListOptions } from "./api/operational_webhook_endpoint";
 export interface SvixOptions {
@@ -27,0 +27,0 @@ debug?: boolean;

dist/index.js

@@ -27,3 +27,3 @@ "use strict";
 const message_attempt_1 = require("./api/message_attempt");
-const op_webhook_endpoint_1 = require("./api/op_webhook_endpoint");
+const operational_webhook_endpoint_1 = require("./api/operational_webhook_endpoint");
 const statistics_1 = require("./api/statistics");
@@ -78,3 +78,3 @@ __exportStar(require("./openapi/models/all"), exports);
         this.statistics = new statistics_1.Statistics(config);
-        this.operationalWebhookEndpoint = new op_webhook_endpoint_1.OperationalWebhookEndpoint(config);
+        this.operationalWebhookEndpoint = new operational_webhook_endpoint_1.OperationalWebhookEndpoint(config);
     }
@@ -81,0 +81,0 @@ }

package.json

 {
   "name": "svix",
-  "version": "1.56.1-next-6676cce4085df5e19ee14cdbdc7fa02ec0f3939c.0",
+  "version": "1.56.1-next-c875ff370e68aad779ff0b24d5fdc553f5c4a5c2.0",
   "description": "Svix webhooks API client and webhook verification library",
@@ -5,0 +5,0 @@ "author": "svix",

src/api/authentication.ts

@@ -1,2 +0,2 @@
-// this file is @generated (with minor manual changes)
+// this file is @generated
 import {
@@ -32,8 +32,11 @@ Configuration,
 
-  public dashboardAccess(
+  /** Expire all of the tokens associated with a specific application. */
+  public expireAll(
     appId: string,
+    applicationTokenExpireIn: ApplicationTokenExpireIn,
     options?: PostOptions
-  ): Promise<DashboardAccessOut> {
-    return this.api.v1AuthenticationDashboardAccess({
+  ): Promise<void> {
+    return this.api.v1AuthenticationExpireAll({
       appId,
+      applicationTokenExpireIn,
       ...options,
@@ -43,11 +46,15 @@ });
 
-  /** Expire all of the tokens associated with a specific application. */
-  public expireAll(
+  /**
+   * DEPRECATED: Please use `app-portal-access` instead.
+   *
+   * Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
+   *
+   * @deprecated
+   */
+  public dashboardAccess(
     appId: string,
-    applicationTokenExpireIn: ApplicationTokenExpireIn,
     options?: PostOptions
-  ): Promise<void> {
-    return this.api.v1AuthenticationExpireAll({
+  ): Promise<DashboardAccessOut> {
+    return this.api.v1AuthenticationDashboardAccess({
       appId,
-      applicationTokenExpireIn,
       ...options,
@@ -54,0 +61,0 @@ });

src/api/background_task.ts

@@ -0,15 +1,23 @@
+// this file is @generated
 import {
   Configuration,
+  BackgroundTasksApi,
+  BackgroundTaskOut,
   BackgroundTaskStatus,
   BackgroundTaskType,
-  BackgroundTaskOut,
   ListResponseBackgroundTaskOut,
-  BackgroundTasksApi,
+  Ordering,
 } from "../openapi";
 
 export interface BackgroundTaskListOptions {
-  iterator?: string | null;
-  limit?: number;
+  /** Filter the response based on the status. */
   status?: BackgroundTaskStatus;
+  /** Filter the response based on the type. */
   task?: BackgroundTaskType;
+  /** Limit the number of returned items */
+  limit?: number;
+  /** The iterator returned from a prior invocation */
+  iterator?: string | null;
+  /** The sorting order of the returned items */
+  order?: Ordering;
 }
@@ -24,9 +32,24 @@
 
+  /** List background tasks executed in the past 90 days. */
+  public list(
+    options?: BackgroundTaskListOptions
+  ): Promise<ListResponseBackgroundTaskOut> {
+    return this.api.listBackgroundTasks({
+      ...options,
+      iterator: options?.iterator ?? undefined,
+    });
+  }
+
+  /**
+   * List background tasks executed in the past 90 days.
+   *
+   * @deprecated Use list instead.
+   * */
   public listByEndpoint(
     options?: BackgroundTaskListOptions
   ): Promise<ListResponseBackgroundTaskOut> {
-    const iterator = options?.iterator ?? undefined;
-    return this.api.listBackgroundTasks({ ...options, iterator });
+    return this.list(options);
   }
 
+  /** Get a background task by ID. */
   public get(taskId: string): Promise<BackgroundTaskOut> {
@@ -33,0 +56,0 @@ return this.api.getBackgroundTask({

src/api/event_type.ts

@@ -1,2 +0,2 @@
-// this file is @generated (with minor manual changes)
+// this file is @generated
 import {
@@ -29,2 +29,7 @@ Configuration,
 
+export interface EventTypeDeleteOptions {
+  /** By default event types are archived when "deleted". Passing this to `true` deletes them entirely. */
+  expunge?: boolean;
+}
+
 export class EventType {
@@ -102,5 +107,6 @@ private readonly api: EventTypeApi;
    */
-  public delete(eventTypeName: string): Promise<void> {
+  public delete(eventTypeName: string, options?: EventTypeDeleteOptions): Promise<void> {
     return this.api.v1EventTypeDelete({
       eventTypeName,
+      ...options,
     });
@@ -107,0 +113,0 @@ }

src/api/integration.ts

@@ -1,2 +0,2 @@
-// this file is @generated (with minor manual changes)
+// this file is @generated
 import {
@@ -84,6 +84,11 @@ Configuration,
 
+  /**
+   * Get an integration's key.
+   *
+   * @deprecated
+   */
   public getKey(appId: string, integId: string): Promise<IntegrationKeyOut> {
     return this.api.v1IntegrationGetKey({
+      appId,
       integId,
-      appId,
     });
@@ -90,0 +95,0 @@ }

src/index.ts

@@ -18,3 +18,3 @@ import {
 import { MessageAttempt } from "./api/message_attempt";
-import { OperationalWebhookEndpoint } from "./api/op_webhook_endpoint";
+import { OperationalWebhookEndpoint } from "./api/operational_webhook_endpoint";
 import { Statistics } from "./api/statistics";
@@ -38,3 +38,3 @@
 } from "./api/message_attempt";
-export { OperationalWebhookEndpointListOptions } from "./api/op_webhook_endpoint";
+export { OperationalWebhookEndpointListOptions } from "./api/operational_webhook_endpoint";
 
@@ -41,0 +41,0 @@ const VERSION = "1.56.0";

No alert changes

Improved metrics

Total package byte prevSize

5217378

increased by0.04%

Lines of code

73256

increased by0.1%

No dependency changes