@shipengine/js-api 1.7.0 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/types.d.ts

@@ -23,6 +23,7 @@ export * from "./shipments/types";
 export * from "./shipping-rules/types";
 export * from "./themes/types";
 export * from "./warehouses/types";
+export * from "./webhooks/types";
 export * from "./weight/types";
 export * from "./weight-band/types";
 export * from "./zones/types";

package/webhooks/api.d.ts

@@ -0,0 +1,48 @@
+import { AxiosInstance } from "axios";
+import { Webhook, WebhookInput } from "./types";
+export type ListWebhookOptions = {
+    includeInactive: boolean;
+};
+/**
+ * # Webhooks API module - /v1/environment/webhooks
+ * https://shipengine.github.io/shipengine-openapi/#tag/webhooks
+ */
+export declare class WebhooksAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of `webhooks`
+     * for a given user.
+     * https://shipengine.github.io/shipengine-openapi/#operation/list_webhooks
+     */
+    list: (options?: ListWebhookOptions) => Promise<import("axios").AxiosResponse<Webhook[], any>>;
+    /**
+     * The `create` method allows the creation of webhooks
+     * for a given user
+     * https://shipengine.github.io/shipengine-openapi/#operation/create_webhook
+     * @param webhook WebhookInput
+     * @returns new WebHook created
+     */
+    create: (webhook: WebhookInput) => Promise<import("axios").AxiosResponse<Webhook, any>>;
+    /**
+     * The `get` method retrieves a given webhooks
+     * @param webhookId string
+     * @returns WebHook
+     */
+    get: (webhookId: string) => Promise<import("axios").AxiosResponse<Webhook, any>>;
+    /**
+     * The `update` method updates a specific webhook for a
+     * given user by `webhookId`.
+     * @param webhookId string
+     * @param webhook new Webhook to update
+     * @returns WebHook updated
+     */
+    update: (webhook: Webhook) => Promise<import("axios").AxiosResponse<Webhook, any>>;
+    /**
+     * The `delete` method deletes a specific webhook
+     * for a given user by `webhookId`.
+     * @param webhookId string
+     * @returns void
+     */
+    delete: (webhookId: string) => Promise<import("axios").AxiosResponse<void, any>>;
+}

package/webhooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./types";

package/webhooks/types.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @category Entities
+ */
+export interface WebhookHeader {
+    key: string;
+    value: string;
+}
+/**
+ * @category Entities
+ */
+export type WebHookEvent = "batch" | "carrier_connected" | "order_source_refresh_complete" | "rate" | "report_complete" | "sales_orders_imported" | "track";
+/**
+ * @category Entities
+ */
+export interface Webhook {
+    event: WebHookEvent;
+    headers?: WebhookHeader[];
+    isActive: boolean;
+    url: string;
+    webhookId: string;
+}
+/**
+ * @category Entities
+ */
+export type WebhookInput = Omit<Webhook, "webhookId" | "isActive">;