@zeriq/api 0.1.0

package/README.md

@@ -0,0 +1,21 @@
+# @zeriq/api
+
+TypeScript SDK for the Zeriq Enterprise Workspace API.
+
+```bash
+npm install @zeriq/api
+```
+
+```ts
+import { ZeriqClient } from "@zeriq/api";
+
+const zeriq = new ZeriqClient({
+  apiToken: process.env.ZERIQ_API_TOKEN!,
+  baseUrl: process.env.ZERIQ_BASE_URL ?? "https://api.zeriq.io/api",
+});
+
+const overview = await zeriq.getOverview();
+const docs = await zeriq.getDeveloperDocs();
+```
+
+Use scoped API tokens and configure IP allowlists, mTLS, quotas, and conditional access in the Zeriq developer portal.

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+export type ZeriqClientOptions = {
+    apiToken: string;
+    baseUrl?: string;
+    idempotencyKey?: string;
+    userAgent?: string;
+};
+export type ZeriqRequestOptions = {
+    method?: "GET" | "POST" | "PATCH" | "DELETE";
+    body?: unknown;
+    headers?: Record<string, string>;
+    idempotencyKey?: string;
+};
+export declare class ZeriqApiError extends Error {
+    readonly status: number;
+    readonly payload: unknown;
+    constructor(message: string, status: number, payload: unknown);
+}
+export declare class ZeriqClient {
+    private readonly apiToken;
+    private readonly baseUrl;
+    private readonly idempotencyKey?;
+    private readonly userAgent;
+    constructor(options: ZeriqClientOptions);
+    request<T = unknown>(path: string, options?: ZeriqRequestOptions): Promise<T>;
+    getOverview<T = unknown>(): Promise<T>;
+    getDeveloperDocs<T = unknown>(): Promise<T>;
+    getDeveloperAnalytics<T = unknown>(days?: number): Promise<T>;
+    getEventDeliveries<T = unknown>(subscriptionId: number | string): Promise<T>;
+    replayEventDelivery<T = unknown>(subscriptionId: number | string, deliveryId: number | string, currentPassword: string): Promise<T>;
+    updateTokenNetworkControls<T = unknown>(tokenId: number | string, controls: Record<string, unknown>): Promise<T>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC7C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,qBAAa,aAAc,SAAQ,KAAK;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAM9D;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,OAAO,EAAE,kBAAkB;IAOjC,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,CAAC,CAAC;IAyBvF,WAAW,CAAC,CAAC,GAAG,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC;IAItC,gBAAgB,CAAC,CAAC,GAAG,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC;IAI3C,qBAAqB,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,SAAK,GAAG,OAAO,CAAC,CAAC,CAAC;IAIzD,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI5E,mBAAmB,CAAC,CAAC,GAAG,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAOnI,0BAA0B,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAMjH"}

package/dist/index.js

@@ -0,0 +1,68 @@
+export class ZeriqApiError extends Error {
+    status;
+    payload;
+    constructor(message, status, payload) {
+        super(message);
+        this.name = "ZeriqApiError";
+        this.status = status;
+        this.payload = payload;
+    }
+}
+export class ZeriqClient {
+    apiToken;
+    baseUrl;
+    idempotencyKey;
+    userAgent;
+    constructor(options) {
+        this.apiToken = options.apiToken;
+        this.baseUrl = (options.baseUrl ?? "https://api.zeriq.io/api").replace(/\/+$/, "");
+        this.idempotencyKey = options.idempotencyKey;
+        this.userAgent = options.userAgent ?? "@zeriq/api/0.1.0";
+    }
+    async request(path, options = {}) {
+        const method = options.method ?? "GET";
+        const idempotencyKey = options.idempotencyKey ?? this.idempotencyKey;
+        const response = await fetch(`${this.baseUrl}/${path.replace(/^\/+/, "")}`, {
+            method,
+            headers: {
+                Accept: "application/json",
+                Authorization: `Bearer ${this.apiToken}`,
+                "Content-Type": "application/json",
+                "User-Agent": this.userAgent,
+                ...(idempotencyKey ? { "Idempotency-Key": idempotencyKey } : {}),
+                ...(options.headers ?? {}),
+            },
+            body: options.body === undefined ? undefined : JSON.stringify(options.body),
+        });
+        const text = await response.text();
+        const payload = text ? JSON.parse(text) : null;
+        if (!response.ok) {
+            throw new ZeriqApiError(payload?.message ?? "Zeriq API request failed.", response.status, payload);
+        }
+        return payload;
+    }
+    getOverview() {
+        return this.request("overview");
+    }
+    getDeveloperDocs() {
+        return this.request("settings/api-tokens/developer-docs");
+    }
+    getDeveloperAnalytics(days = 30) {
+        return this.request(`settings/api-tokens/developer-analytics?days=${encodeURIComponent(String(days))}`);
+    }
+    getEventDeliveries(subscriptionId) {
+        return this.request(`settings/api-tokens/event-subscriptions/${subscriptionId}/deliveries`);
+    }
+    replayEventDelivery(subscriptionId, deliveryId, currentPassword) {
+        return this.request(`settings/api-tokens/event-subscriptions/${subscriptionId}/deliveries/${deliveryId}/replay`, {
+            method: "POST",
+            body: { current_password: currentPassword },
+        });
+    }
+    updateTokenNetworkControls(tokenId, controls) {
+        return this.request(`settings/api-tokens/${tokenId}/network-controls`, {
+            method: "PATCH",
+            body: controls,
+        });
+    }
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@zeriq/api",
+  "version": "0.1.0",
+  "description": "TypeScript SDK for the Zeriq Enterprise Workspace API.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "zeriq",
+    "finpay",
+    "api",
+    "workspace",
+    "enterprise"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Veltrix-Digital-Innovations-LTD/zeriq-typescript-sdk.git"
+  },
+  "homepage": "https://api.zeriq.io/api/developer/api-tokens/docs",
+  "bugs": {
+    "url": "https://github.com/Veltrix-Digital-Innovations-LTD/zeriq-typescript-sdk/issues"
+  },
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}