@fern-api/postman 0.0.2

package/dist/esm/errors/index.d.mts

@@ -0,0 +1,2 @@
+export { FernPostmanError } from "./FernPostmanError.mjs";
+export { FernPostmanTimeoutError } from "./FernPostmanTimeoutError.mjs";

package/dist/esm/errors/index.mjs

@@ -0,0 +1,2 @@
+export { FernPostmanError } from "./FernPostmanError.mjs";
+export { FernPostmanTimeoutError } from "./FernPostmanTimeoutError.mjs";

package/dist/esm/exports.d.mts

@@ -0,0 +1 @@
+export * from "./core/exports.mjs";

package/dist/esm/exports.mjs

@@ -0,0 +1 @@
+export * from "./core/exports.mjs";

package/dist/esm/index.d.mts

@@ -0,0 +1,6 @@
+export * as FernPostman from "./api/index.mjs";
+export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
+export { FernPostmanClient } from "./Client.mjs";
+export { FernPostmanEnvironment } from "./environments.mjs";
+export { FernPostmanError, FernPostmanTimeoutError } from "./errors/index.mjs";
+export * from "./exports.mjs";

package/dist/esm/index.mjs

@@ -0,0 +1,5 @@
+export * as FernPostman from "./api/index.mjs";
+export { FernPostmanClient } from "./Client.mjs";
+export { FernPostmanEnvironment } from "./environments.mjs";
+export { FernPostmanError, FernPostmanTimeoutError } from "./errors/index.mjs";
+export * from "./exports.mjs";

package/dist/esm/version.d.mts

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "0.0.2";

package/dist/esm/version.mjs

@@ -0,0 +1 @@
+export const SDK_VERSION = "0.0.2";

package/package.json

@@ -0,0 +1,69 @@
+{
+    "name": "@fern-api/postman",
+    "version": "0.0.2",
+    "private": false,
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fern-api/postman-sdk.git"
+    },
+    "type": "commonjs",
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/esm/index.mjs",
+    "types": "./dist/cjs/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/cjs/index.d.ts",
+            "import": {
+                "types": "./dist/esm/index.d.mts",
+                "default": "./dist/esm/index.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/index.d.ts",
+                "default": "./dist/cjs/index.js"
+            },
+            "default": "./dist/cjs/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist",
+        "reference.md",
+        "README.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "build": "pnpm build:cjs && pnpm build:esm",
+        "build:cjs": "tsc --project ./tsconfig.cjs.json",
+        "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
+        "test": "vitest",
+        "test:unit": "vitest --project unit",
+        "test:wire": "vitest --project wire"
+    },
+    "dependencies": {},
+    "devDependencies": {
+        "webpack": "^5.97.1",
+        "ts-loader": "^9.5.1",
+        "vitest": "^3.2.4",
+        "msw": "2.11.2",
+        "@types/node": "^18.19.70",
+        "typescript": "~5.7.2",
+        "@biomejs/biome": "2.3.11"
+    },
+    "browser": {
+        "fs": false,
+        "os": false,
+        "path": false,
+        "stream": false
+    },
+    "packageManager": "pnpm@10.20.0",
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "sideEffects": false
+}

package/reference.md

@@ -0,0 +1,193 @@
+# Reference
+<details><summary><code>client.<a href="/src/Client.ts">check</a>() -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Check endpoint to verify the API key is valid.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.check();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `FernPostmanClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Collection
+<details><summary><code>client.collection.<a href="/src/api/resources/collection/client/Client.ts">getStatus</a>(collectionId) -> FernPostman.GetCollectionStatusResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the publishing status of the Postman collection as documentation.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.collection.getStatus("collectionId");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**collectionId:** `FernPostman.CollectionId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CollectionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.collection.<a href="/src/api/resources/collection/client/Client.ts">publish</a>(collectionId, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Initiates a request to publish the Postman collection as a Fern documentation site.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.collection.publish("collectionId", {
+    userId: "userId",
+    teamId: "teamId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**collectionId:** `FernPostman.CollectionId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `FernPostman.PublishCollectionRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CollectionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>