@foru-ms/sdk 2.1.0 → 2.1.1

package/dist/esm/api/types/UserCreate.d.mts

@@ -0,0 +1,20 @@
+export interface UserCreate {
+    /** Username (letters, numbers, underscores, hyphens) */
+    username: string;
+    /** Email address */
+    email?: string;
+    /** Password (min 8 chars) */
+    password?: string;
+    /** Display name */
+    displayName?: string;
+    /** User bio */
+    bio?: string;
+    /** Forum signature */
+    signature?: string;
+    /** Website URL */
+    url?: string;
+    /** Role slugs to assign */
+    roles?: string[];
+    /** Custom extended data */
+    extendedData?: Record<string, unknown>;
+}

package/dist/esm/api/types/UserCreate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Webhook.d.mts

@@ -8,6 +8,8 @@ export interface Webhook {
     events: string[];
     /** Whether webhook is active */
     active: boolean;
+    /** Custom extended data */
+    extendedData: Record<string, unknown> | null;
     /** Last trigger timestamp */
     lastTriggered: string | null;
     /** Consecutive failure count */

package/dist/esm/api/types/WebhookCreate.d.mts

@@ -7,4 +7,8 @@ export interface WebhookCreate {
     events: string[];
     /** Secret for signature verification (auto-generated if missing) */
     secret?: string;
+    /** Whether webhook is active */
+    active?: boolean;
+    /** Custom extended data */
+    extendedData?: Record<string, unknown>;
 }

package/dist/esm/api/types/WebhookListResponse.d.mts

@@ -22,6 +22,8 @@ export declare namespace WebhookListResponse {
                 events: string[];
                 /** Whether webhook is active */
                 active: boolean;
+                /** Custom extended data */
+                extendedData: Record<string, unknown> | null;
                 /** Last trigger timestamp */
                 lastTriggered: string | null;
                 /** Consecutive failure count */

package/dist/esm/api/types/WebhookResponse.d.mts

@@ -12,6 +12,8 @@ export declare namespace WebhookResponse {
         events: string[];
         /** Whether webhook is active */
         active: boolean;
+        /** Custom extended data */
+        extendedData: Record<string, unknown> | null;
         /** Last trigger timestamp */
         lastTriggered: string | null;
         /** Consecutive failure count */

package/dist/esm/api/types/WebhookUpdate.d.mts

@@ -0,0 +1,14 @@
+export interface WebhookUpdate {
+    /** Webhook name */
+    name?: string;
+    /** Target URL */
+    url?: string;
+    /** Event types to trigger on */
+    events?: string[];
+    /** New secret */
+    secret?: string;
+    /** Enable/disable webhook */
+    active?: boolean;
+    /** Custom extended data */
+    extendedData?: Record<string, unknown>;
+}

package/dist/esm/api/types/WebhookUpdate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

@@ -5,6 +5,7 @@ export * from "./ErrorResponse.mjs";
 export * from "./ForgotPasswordResponse.mjs";
 export * from "./Integration.mjs";
 export * from "./IntegrationCreate.mjs";
+export * from "./IntegrationList.mjs";
 export * from "./IntegrationListResponse.mjs";
 export * from "./IntegrationResponse.mjs";
 export * from "./IntegrationUpdate.mjs";
@@ -38,20 +39,27 @@ export * from "./PrivateMessageReplyCreate.mjs";
 export * from "./PrivateMessageReplyListResponse.mjs";
 export * from "./PrivateMessageReplyResponse.mjs";
 export * from "./PrivateMessageResponse.mjs";
+export * from "./PrivateMessageUpdate.mjs";
 export * from "./RegisterResponse.mjs";
 export * from "./Report.mjs";
 export * from "./ReportCreate.mjs";
 export * from "./ReportList.mjs";
 export * from "./ReportListResponse.mjs";
 export * from "./ReportResponse.mjs";
+export * from "./ReportUpdate.mjs";
 export * from "./ResetPasswordResponse.mjs";
 export * from "./Role.mjs";
 export * from "./RoleCreate.mjs";
+export * from "./RoleList.mjs";
 export * from "./RoleListResponse.mjs";
 export * from "./RoleResponse.mjs";
 export * from "./RoleUpdate.mjs";
+export * from "./Search.mjs";
+export * from "./SearchListResponse.mjs";
+export * from "./SearchResponse.mjs";
 export * from "./Sso.mjs";
 export * from "./SsoCreate.mjs";
+export * from "./SsoList.mjs";
 export * from "./SsoListResponse.mjs";
 export * from "./SsoResponse.mjs";
 export * from "./SsoUpdate.mjs";
@@ -86,6 +94,7 @@ export * from "./ThreadSubscriberListResponse.mjs";
 export * from "./ThreadSubscriberResponse.mjs";
 export * from "./ThreadUpdate.mjs";
 export * from "./User.mjs";
+export * from "./UserCreate.mjs";
 export * from "./UserFollower.mjs";
 export * from "./UserFollowerListResponse.mjs";
 export * from "./UserFollowerResponse.mjs";
@@ -104,3 +113,4 @@ export * from "./WebhookDeliveryResponse.mjs";
 export * from "./WebhookList.mjs";
 export * from "./WebhookListResponse.mjs";
 export * from "./WebhookResponse.mjs";
+export * from "./WebhookUpdate.mjs";

package/dist/esm/api/types/index.mjs

@@ -5,6 +5,7 @@ export * from "./ErrorResponse.mjs";
 export * from "./ForgotPasswordResponse.mjs";
 export * from "./Integration.mjs";
 export * from "./IntegrationCreate.mjs";
+export * from "./IntegrationList.mjs";
 export * from "./IntegrationListResponse.mjs";
 export * from "./IntegrationResponse.mjs";
 export * from "./IntegrationUpdate.mjs";
@@ -38,20 +39,27 @@ export * from "./PrivateMessageReplyCreate.mjs";
 export * from "./PrivateMessageReplyListResponse.mjs";
 export * from "./PrivateMessageReplyResponse.mjs";
 export * from "./PrivateMessageResponse.mjs";
+export * from "./PrivateMessageUpdate.mjs";
 export * from "./RegisterResponse.mjs";
 export * from "./Report.mjs";
 export * from "./ReportCreate.mjs";
 export * from "./ReportList.mjs";
 export * from "./ReportListResponse.mjs";
 export * from "./ReportResponse.mjs";
+export * from "./ReportUpdate.mjs";
 export * from "./ResetPasswordResponse.mjs";
 export * from "./Role.mjs";
 export * from "./RoleCreate.mjs";
+export * from "./RoleList.mjs";
 export * from "./RoleListResponse.mjs";
 export * from "./RoleResponse.mjs";
 export * from "./RoleUpdate.mjs";
+export * from "./Search.mjs";
+export * from "./SearchListResponse.mjs";
+export * from "./SearchResponse.mjs";
 export * from "./Sso.mjs";
 export * from "./SsoCreate.mjs";
+export * from "./SsoList.mjs";
 export * from "./SsoListResponse.mjs";
 export * from "./SsoResponse.mjs";
 export * from "./SsoUpdate.mjs";
@@ -86,6 +94,7 @@ export * from "./ThreadSubscriberListResponse.mjs";
 export * from "./ThreadSubscriberResponse.mjs";
 export * from "./ThreadUpdate.mjs";
 export * from "./User.mjs";
+export * from "./UserCreate.mjs";
 export * from "./UserFollower.mjs";
 export * from "./UserFollowerListResponse.mjs";
 export * from "./UserFollowerResponse.mjs";
@@ -104,3 +113,4 @@ export * from "./WebhookDeliveryResponse.mjs";
 export * from "./WebhookList.mjs";
 export * from "./WebhookListResponse.mjs";
 export * from "./WebhookResponse.mjs";
+export * from "./WebhookUpdate.mjs";

package/dist/esm/auth/HeaderAuthProvider.d.mts

@@ -1,16 +1,20 @@
 import * as core from "../core/index.mjs";
-export declare namespace HeaderAuthProvider {
-    interface AuthOptions {
-        apiKey: core.Supplier<string>;
-    }
-    interface Options extends AuthOptions {
-    }
-}
+declare const PARAM_KEY: "apiKey";
 export declare class HeaderAuthProvider implements core.AuthProvider {
-    private readonly headerValue;
+    private readonly options;
     constructor(options: HeaderAuthProvider.Options);
-    static canCreate(options: HeaderAuthProvider.Options): boolean;
-    getAuthRequest(_arg?: {
+    static canCreate(options: Partial<HeaderAuthProvider.Options>): boolean;
+    getAuthRequest({ endpointMetadata, }?: {
         endpointMetadata?: core.EndpointMetadata;
     }): Promise<core.AuthRequest>;
 }
+export declare namespace HeaderAuthProvider {
+    const AUTH_SCHEME: "ApiKeyAuth";
+    const AUTH_CONFIG_ERROR_MESSAGE: string;
+    type Options = AuthOptions;
+    type AuthOptions = {
+        [PARAM_KEY]?: core.Supplier<string>;
+    };
+    function createInstance(options: Options): core.AuthProvider;
+}
+export {};

package/dist/esm/auth/HeaderAuthProvider.mjs

@@ -10,25 +10,34 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import * as core from "../core/index.mjs";
 import * as errors from "../errors/index.mjs";
+const PARAM_KEY = "apiKey";
+const HEADER_NAME = "x-api-key";
 export class HeaderAuthProvider {
     constructor(options) {
-        this.headerValue = options.apiKey;
+        this.options = options;
     }
     static canCreate(options) {
-        return options.apiKey != null;
+        return (options === null || options === void 0 ? void 0 : options[PARAM_KEY]) != null;
     }
-    getAuthRequest(_arg) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const apiKey = yield core.Supplier.get(this.headerValue);
-            if (apiKey == null) {
+    getAuthRequest() {
+        return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
+            const headerValue = yield core.Supplier.get(this.options[PARAM_KEY]);
+            if (headerValue == null) {
                 throw new errors.ForumError({
-                    message: "Please specify a apiKey by passing it in to the constructor",
+                    message: HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
                 });
             }
-            const headerValue = apiKey;
             return {
-                headers: { "x-api-key": headerValue },
+                headers: { [HEADER_NAME]: headerValue },
             };
         });
     }
 }
+(function (HeaderAuthProvider) {
+    HeaderAuthProvider.AUTH_SCHEME = "ApiKeyAuth";
+    HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${PARAM_KEY}' when initializing the client`;
+    function createInstance(options) {
+        return new HeaderAuthProvider(options);
+    }
+    HeaderAuthProvider.createInstance = createInstance;
+})(HeaderAuthProvider || (HeaderAuthProvider = {}));

package/dist/esm/core/fetcher/EndpointSupplier.d.mts

@@ -1,12 +1,12 @@
 import type { EndpointMetadata } from "./EndpointMetadata.mjs";
 import type { Supplier } from "./Supplier.mjs";
 type EndpointSupplierFn<T> = (arg: {
-    endpointMetadata: EndpointMetadata;
+    endpointMetadata?: EndpointMetadata;
 }) => T | Promise<T>;
 export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
 export declare const EndpointSupplier: {
     get: <T>(supplier: EndpointSupplier<T>, arg: {
-        endpointMetadata: EndpointMetadata;
+        endpointMetadata?: EndpointMetadata;
     }) => Promise<T>;
 };
 export {};

package/dist/esm/core/fetcher/Fetcher.d.mts

@@ -1,14 +1,13 @@
 import { type LogConfig, type Logger } from "../logging/logger.mjs";
 import type { APIResponse } from "./APIResponse.mjs";
 import type { EndpointMetadata } from "./EndpointMetadata.mjs";
-import { EndpointSupplier } from "./EndpointSupplier.mjs";
 export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
 export declare namespace Fetcher {
     interface Args {
         url: string;
         method: string;
         contentType?: string;
-        headers?: Record<string, string | EndpointSupplier<string | null | undefined> | null | undefined>;
+        headers?: Record<string, unknown>;
         queryParameters?: Record<string, unknown>;
         body?: unknown;
         timeoutMs?: number;

package/dist/esm/core/headers.d.mts

@@ -1,2 +1,2 @@
-export declare function mergeHeaders<THeaderValue>(...headersArray: (Record<string, THeaderValue> | null | undefined)[]): Record<string, string | THeaderValue>;
-export declare function mergeOnlyDefinedHeaders<THeaderValue>(...headersArray: (Record<string, THeaderValue> | null | undefined)[]): Record<string, THeaderValue>;
+export declare function mergeHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
+export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.9";
+export declare const SDK_VERSION = "2.1.1";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.9";
+export const SDK_VERSION = "2.1.1";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@foru-ms/sdk",
-    "version": "2.1.0",
+    "version": "2.1.1",
     "private": false,
     "repository": {
         "type": "git",
@@ -51,7 +51,7 @@
         "vitest": "^3.2.4",
         "@types/node": "^18.19.70",
         "typescript": "~5.7.2",
-        "@biomejs/biome": "2.3.1"
+        "@biomejs/biome": "2.3.11"
     },
     "browser": {
         "fs": false,

package/reference.md

@@ -300,6 +300,48 @@ await client.auth.resetPassword({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Search
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>() -> Forum.SearchSearchResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.search.search();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `SearchClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2837,6 +2879,71 @@ await client.privateMessages.delete({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.privateMessages.<a href="/src/api/resources/privateMessages/client/Client.ts">update</a>({ ...params }) -> Forum.UpdatePrivateMessagesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an existing private message. Only provided fields will be modified.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.privateMessages.update({
+    id: "id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.UpdatePrivateMessagesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PrivateMessagesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3137,6 +3244,71 @@ await client.users.list();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">create</a>({ ...params }) -> Forum.UserResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new user.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.users.create({
+    username: "username"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.CreateUsersRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `UsersClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -4253,6 +4425,71 @@ await client.reports.delete({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.reports.<a href="/src/api/resources/reports/client/Client.ts">update</a>({ ...params }) -> Forum.UpdateReportsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an existing report. Only provided fields will be modified.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.reports.update({
+    id: "id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.UpdateReportsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ReportsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -4847,6 +5084,73 @@ await client.webhooks.delete({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">update</a>({ ...params }) -> Forum.UpdateWebhooksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an existing webhook. Only provided fields will be modified.
+
+**Requires feature: webhooks**
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.webhooks.update({
+    id: "id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.UpdateWebhooksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebhooksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>