@kaiban/sdk 0.1.1

package/dist/lib/resources/ExternalChannelsClient.d.ts

@@ -0,0 +1,65 @@
+import { HttpClient } from '../http/HttpClient';
+import { RequestOptions } from '../http/types';
+import { ExternalChannel } from '../../types/entities';
+import { ListParams, Paginated } from '../../types/responses';
+/**
+ * Client for managing external channels in the Kaiban platform
+ * External channels represent integrations with external communication platforms
+ * @category Resources
+ */
+export declare class ExternalChannelsClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * List external channels with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for the next page of results
+     * @param params.limit - Number of items per page
+     * @param params.order_by - Fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of external channels
+     *
+     * @example
+     * ```typescript
+     * const result = await client.externalChannels.list({ limit: 15 });
+     * console.log(result.items);
+     * ```
+     */
+    list(params?: ListParams, options?: RequestOptions): Promise<Paginated<ExternalChannel>>;
+    /**
+     * Iterate through all external channels using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual ExternalChannel objects
+     *
+     * @example
+     * ```typescript
+     * for await (const channel of client.externalChannels.listAll()) {
+     *   console.log(channel.id, channel.platform, channel.name);
+     * }
+     * ```
+     */
+    listAll(params?: Omit<ListParams, 'cursor'>, options?: RequestOptions): AsyncGenerator<ExternalChannel, void, unknown>;
+    /**
+     * Get a single external channel by ID
+     *
+     * @param id - The unique identifier of the external channel
+     * @param options - Optional request configuration
+     *
+     * @returns The external channel object
+     *
+     * @throws {Error} If the channel is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const channel = await client.externalChannels.get('channel-123');
+     * console.log(channel.platform, channel.configuration);
+     * ```
+     */
+    get(id: string, options?: RequestOptions): Promise<ExternalChannel>;
+}

package/dist/lib/resources/ExternalChannelsClient.js

@@ -0,0 +1,74 @@
+/**
+ * Client for managing external channels in the Kaiban platform
+ * External channels represent integrations with external communication platforms
+ * @category Resources
+ */
+export class ExternalChannelsClient {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * List external channels with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for the next page of results
+     * @param params.limit - Number of items per page
+     * @param params.order_by - Fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of external channels
+     *
+     * @example
+     * ```typescript
+     * const result = await client.externalChannels.list({ limit: 15 });
+     * console.log(result.items);
+     * ```
+     */
+    list(params, options) {
+        return this.http.list('/external-channels', params, options);
+    }
+    /**
+     * Iterate through all external channels using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual ExternalChannel objects
+     *
+     * @example
+     * ```typescript
+     * for await (const channel of client.externalChannels.listAll()) {
+     *   console.log(channel.id, channel.platform, channel.name);
+     * }
+     * ```
+     */
+    async *listAll(params, options) {
+        let cursor = undefined;
+        do {
+            const page = await this.list({ ...(params || {}), cursor }, options);
+            for (const item of page.data)
+                yield item;
+            cursor = page.meta.next_cursor;
+        } while (cursor);
+    }
+    /**
+     * Get a single external channel by ID
+     *
+     * @param id - The unique identifier of the external channel
+     * @param options - Optional request configuration
+     *
+     * @returns The external channel object
+     *
+     * @throws {Error} If the channel is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const channel = await client.externalChannels.get('channel-123');
+     * console.log(channel.platform, channel.configuration);
+     * ```
+     */
+    get(id, options) {
+        return this.http.get(`/external-channel/${encodeURIComponent(id)}`, options);
+    }
+}

package/dist/lib/resources/ResourcesClient.d.ts

@@ -0,0 +1,92 @@
+import { HttpClient } from '../http/HttpClient';
+import { RequestOptions } from '../http/types';
+import { Resource } from '../../types/entities';
+import { ListParams, Paginated } from '../../types/responses';
+/**
+ * Client for managing resources in the Kaiban platform
+ * Resources can include documents, files, or other materials
+ * @category Resources
+ */
+export declare class ResourcesClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * List resources with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for the next page of results
+     * @param params.limit - Number of items per page
+     * @param params.order_by - Fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of resources
+     *
+     * @example
+     * ```typescript
+     * const result = await client.resources.list({ limit: 25 });
+     * console.log(result.items);
+     * ```
+     */
+    list(params?: ListParams, options?: RequestOptions): Promise<Paginated<Resource>>;
+    /**
+     * Iterate through all resources using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual Resource objects
+     *
+     * @example
+     * ```typescript
+     * for await (const resource of client.resources.listAll()) {
+     *   console.log(resource.id, resource.name);
+     * }
+     * ```
+     */
+    listAll(params?: Omit<ListParams, 'cursor'>, options?: RequestOptions): AsyncGenerator<Resource, void, unknown>;
+    /**
+     * Get a single resource by ID
+     *
+     * @param id - The unique identifier of the resource
+     * @param options - Optional request configuration
+     *
+     * @returns The resource object
+     *
+     * @throws {Error} If the resource is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const resource = await client.resources.get('resource-123');
+     * console.log(resource.name, resource.type);
+     * ```
+     */
+    get(id: string, options?: RequestOptions): Promise<Resource>;
+    /**
+     * Publish a resource to make it available
+     *
+     * @param params - Publish parameters
+     * @param params.resource_id - The unique identifier of the resource to publish
+     * @param params.userId - The ID of the user publishing the resource
+     * @param options - Optional request configuration
+     *
+     * @returns A response with a success message
+     *
+     * @throws {Error} If the resource is not found or publish fails
+     *
+     * @example
+     * ```typescript
+     * const result = await client.resources.publish({
+     *   resource_id: 'resource-123',
+     *   userId: 'user-456'
+     * });
+     * console.log(result.message);
+     * ```
+     */
+    publish(params: {
+        resource_id: string;
+        userId: string;
+    }, options?: RequestOptions): Promise<{
+        message: string;
+    }>;
+}

package/dist/lib/resources/ResourcesClient.js

@@ -0,0 +1,98 @@
+/**
+ * Client for managing resources in the Kaiban platform
+ * Resources can include documents, files, or other materials
+ * @category Resources
+ */
+export class ResourcesClient {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * List resources with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for the next page of results
+     * @param params.limit - Number of items per page
+     * @param params.order_by - Fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of resources
+     *
+     * @example
+     * ```typescript
+     * const result = await client.resources.list({ limit: 25 });
+     * console.log(result.items);
+     * ```
+     */
+    list(params, options) {
+        return this.http.list('/resources', params, options);
+    }
+    /**
+     * Iterate through all resources using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual Resource objects
+     *
+     * @example
+     * ```typescript
+     * for await (const resource of client.resources.listAll()) {
+     *   console.log(resource.id, resource.name);
+     * }
+     * ```
+     */
+    async *listAll(params, options) {
+        let cursor = undefined;
+        do {
+            const page = await this.list({ ...(params || {}), cursor }, options);
+            for (const item of page.data)
+                yield item;
+            cursor = page.meta.next_cursor;
+        } while (cursor);
+    }
+    /**
+     * Get a single resource by ID
+     *
+     * @param id - The unique identifier of the resource
+     * @param options - Optional request configuration
+     *
+     * @returns The resource object
+     *
+     * @throws {Error} If the resource is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const resource = await client.resources.get('resource-123');
+     * console.log(resource.name, resource.type);
+     * ```
+     */
+    get(id, options) {
+        return this.http.get(`/resource/${encodeURIComponent(id)}`, options);
+    }
+    /**
+     * Publish a resource to make it available
+     *
+     * @param params - Publish parameters
+     * @param params.resource_id - The unique identifier of the resource to publish
+     * @param params.userId - The ID of the user publishing the resource
+     * @param options - Optional request configuration
+     *
+     * @returns A response with a success message
+     *
+     * @throws {Error} If the resource is not found or publish fails
+     *
+     * @example
+     * ```typescript
+     * const result = await client.resources.publish({
+     *   resource_id: 'resource-123',
+     *   userId: 'user-456'
+     * });
+     * console.log(result.message);
+     * ```
+     */
+    publish(params, options) {
+        return this.http.post(`/resource/${encodeURIComponent(params.resource_id)}/publish`, { userId: params.userId }, options);
+    }
+}

package/dist/lib/resources/SupervisorFeedbackClient.d.ts

@@ -0,0 +1,75 @@
+import { HttpClient } from '../http/HttpClient';
+import { RequestOptions } from '../http/types';
+import { ListParams, Paginated } from '../../types/responses';
+/**
+ * Supervisor feedback item
+ */
+export interface SupervisorFeedbackItem {
+    /** Unique identifier for the feedback */
+    id: string;
+    /** The ID of the agent receiving feedback */
+    agent_id: string;
+    /** The feedback text */
+    feedback: string;
+    /** Timestamp when the feedback was created */
+    created_at: string;
+}
+/**
+ * Client for managing supervisor feedback in the Kaiban platform
+ * Supervisor feedback tracks feedback given to agents by supervisors
+ * @category Resources
+ */
+export declare class SupervisorFeedbackClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * List supervisor feedback for a specific agent
+     *
+     * @param params - Query parameters including agent_id and pagination options
+     * @param params.agent_id - The unique identifier of the agent
+     * @param params.cursor - Optional cursor for the next page of results
+     * @param params.limit - Optional number of items per page
+     * @param params.order_by - Optional fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of supervisor feedback items
+     *
+     * @example
+     * ```typescript
+     * const result = await client.supervisorFeedback.listByAgent({
+     *   agent_id: 'agent-123',
+     *   limit: 20,
+     *   order_by: ['created_at']
+     * });
+     *
+     * result.items.forEach(feedback => {
+     *   console.log(feedback.feedback, feedback.created_at);
+     * });
+     * ```
+     */
+    listByAgent(params: {
+        agent_id: string;
+    } & ListParams, options?: RequestOptions): Promise<Paginated<SupervisorFeedbackItem>>;
+    /**
+     * Iterate through all feedback for a specific agent using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Query parameters including agent_id (excluding cursor)
+     * @param params.agent_id - The unique identifier of the agent
+     * @param options - Optional request configuration
+     *
+     * @yields Individual SupervisorFeedbackItem objects
+     *
+     * @example
+     * ```typescript
+     * for await (const feedback of client.supervisorFeedback.listAllByAgent({
+     *   agent_id: 'agent-123'
+     * })) {
+     *   console.log(feedback.feedback, feedback.created_at);
+     * }
+     * ```
+     */
+    listAllByAgent(params: {
+        agent_id: string;
+    } & Omit<ListParams, 'cursor'>, options?: RequestOptions): AsyncGenerator<SupervisorFeedbackItem, void, unknown>;
+}

package/dist/lib/resources/SupervisorFeedbackClient.js

@@ -0,0 +1,67 @@
+/**
+ * Client for managing supervisor feedback in the Kaiban platform
+ * Supervisor feedback tracks feedback given to agents by supervisors
+ * @category Resources
+ */
+export class SupervisorFeedbackClient {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * List supervisor feedback for a specific agent
+     *
+     * @param params - Query parameters including agent_id and pagination options
+     * @param params.agent_id - The unique identifier of the agent
+     * @param params.cursor - Optional cursor for the next page of results
+     * @param params.limit - Optional number of items per page
+     * @param params.order_by - Optional fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of supervisor feedback items
+     *
+     * @example
+     * ```typescript
+     * const result = await client.supervisorFeedback.listByAgent({
+     *   agent_id: 'agent-123',
+     *   limit: 20,
+     *   order_by: ['created_at']
+     * });
+     *
+     * result.items.forEach(feedback => {
+     *   console.log(feedback.feedback, feedback.created_at);
+     * });
+     * ```
+     */
+    listByAgent(params, options) {
+        const { agent_id, ...rest } = params;
+        return this.http.list(`/supervisor-feedback/${encodeURIComponent(agent_id)}`, rest, options);
+    }
+    /**
+     * Iterate through all feedback for a specific agent using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Query parameters including agent_id (excluding cursor)
+     * @param params.agent_id - The unique identifier of the agent
+     * @param options - Optional request configuration
+     *
+     * @yields Individual SupervisorFeedbackItem objects
+     *
+     * @example
+     * ```typescript
+     * for await (const feedback of client.supervisorFeedback.listAllByAgent({
+     *   agent_id: 'agent-123'
+     * })) {
+     *   console.log(feedback.feedback, feedback.created_at);
+     * }
+     * ```
+     */
+    async *listAllByAgent(params, options) {
+        let cursor = undefined;
+        do {
+            const page = await this.listByAgent({ ...params, cursor }, options);
+            for (const item of page.data)
+                yield item;
+            cursor = page.meta.next_cursor;
+        } while (cursor);
+    }
+}

package/dist/lib/resources/TeamMembersClient.d.ts

@@ -0,0 +1,66 @@
+import { HttpClient } from '../http/HttpClient';
+import { RequestOptions } from '../http/types';
+import { TeamMember } from '../../types/entities';
+import { ListParams, Paginated } from '../../types/responses';
+/**
+ * Client for managing team members in the Kaiban platform
+ * @category Resources
+ */
+export declare class TeamMembersClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * List team members with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for the next page of results
+     * @param params.limit - Number of items per page
+     * @param params.order_by - Fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of team members
+     *
+     * @example
+     * ```typescript
+     * const result = await client.teamMembers.list({
+     *   limit: 50,
+     *   order_by: ['name']
+     * });
+     * ```
+     */
+    list(params?: ListParams, options?: RequestOptions): Promise<Paginated<TeamMember>>;
+    /**
+     * Iterate through all team members using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual TeamMember objects
+     *
+     * @example
+     * ```typescript
+     * for await (const member of client.teamMembers.listAll()) {
+     *   console.log(member.id, member.name, member.role);
+     * }
+     * ```
+     */
+    listAll(params?: Omit<ListParams, 'cursor'>, options?: RequestOptions): AsyncGenerator<TeamMember, void, unknown>;
+    /**
+     * Get a single team member by ID
+     *
+     * @param id - The unique identifier of the team member
+     * @param options - Optional request configuration
+     *
+     * @returns The team member object
+     *
+     * @throws {Error} If the team member is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const member = await client.teamMembers.get('member-123');
+     * console.log(member.name, member.role);
+     * ```
+     */
+    get(id: string, options?: RequestOptions): Promise<TeamMember>;
+}

package/dist/lib/resources/TeamMembersClient.js

@@ -0,0 +1,75 @@
+/**
+ * Client for managing team members in the Kaiban platform
+ * @category Resources
+ */
+export class TeamMembersClient {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * List team members with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for the next page of results
+     * @param params.limit - Number of items per page
+     * @param params.order_by - Fields to sort by
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of team members
+     *
+     * @example
+     * ```typescript
+     * const result = await client.teamMembers.list({
+     *   limit: 50,
+     *   order_by: ['name']
+     * });
+     * ```
+     */
+    list(params, options) {
+        return this.http.list('/team-members', params, options);
+    }
+    /**
+     * Iterate through all team members using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual TeamMember objects
+     *
+     * @example
+     * ```typescript
+     * for await (const member of client.teamMembers.listAll()) {
+     *   console.log(member.id, member.name, member.role);
+     * }
+     * ```
+     */
+    async *listAll(params, options) {
+        let pageToken = undefined;
+        do {
+            const page = await this.list({ ...(params || {}), cursor: pageToken }, options);
+            for (const item of page.items)
+                yield item;
+            pageToken = page.next_page_token;
+        } while (pageToken);
+    }
+    /**
+     * Get a single team member by ID
+     *
+     * @param id - The unique identifier of the team member
+     * @param options - Optional request configuration
+     *
+     * @returns The team member object
+     *
+     * @throws {Error} If the team member is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const member = await client.teamMembers.get('member-123');
+     * console.log(member.name, member.role);
+     * ```
+     */
+    get(id, options) {
+        return this.http.get(`/team-member/${encodeURIComponent(id)}`, options);
+    }
+}

package/dist/lib/resources/TeamsClient.d.ts

@@ -0,0 +1,83 @@
+import { HttpClient } from '../http/HttpClient';
+import { RequestOptions } from '../http/types';
+import { Team } from '../../types/entities';
+import { ListParams, Paginated } from '../../types/responses';
+/**
+ * Client for managing teams in the Kaiban platform
+ * @category Resources
+ */
+export declare class TeamsClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * List teams with pagination, filters, and sorting
+     *
+     * @param params - Optional query parameters for filtering and pagination
+     * @param params.cursor - Cursor for pagination (from previous/next response)
+     * @param params.limit - Number of items per page (default: 50, max: 100)
+     * @param params.order_by - Fields to sort by. Use - prefix for descending order
+     * @param params.filters - Filter parameters (e.g., { status: 'active' })
+     * @param options - Optional request configuration
+     *
+     * @returns A paginated list of teams
+     *
+     * @example
+     * ```typescript
+     * // Basic pagination
+     * const result = await client.teams.list({ limit: 20 });
+     * console.log(result.data); // Current page items
+     * console.log(result.pagination.next_cursor); // Use for next page
+     *
+     * // With sorting
+     * const sorted = await client.teams.list({
+     *   order_by: '-created_at',
+     *   limit: 50
+     * });
+     *
+     * // With filters
+     * const filtered = await client.teams.list({
+     *   filters: { status: 'active' }
+     * });
+     *
+     * // Next page
+     * const nextPage = await client.teams.list({
+     *   cursor: result.pagination.next_cursor
+     * });
+     * ```
+     */
+    list(params?: ListParams, options?: RequestOptions): Promise<Paginated<Team>>;
+    /**
+     * Iterate through all teams using async generator
+     * Automatically handles pagination by following next_page_token
+     *
+     * @param params - Optional query parameters (excluding cursor)
+     * @param options - Optional request configuration
+     *
+     * @yields Individual Team objects
+     *
+     * @example
+     * ```typescript
+     * for await (const team of client.teams.listAll()) {
+     *   console.log(team.id, team.name);
+     * }
+     * ```
+     */
+    listAll(params?: Omit<ListParams, 'cursor'>, options?: RequestOptions): AsyncGenerator<Team, void, unknown>;
+    /**
+     * Get a single team by ID
+     *
+     * @param id - The unique identifier of the team
+     * @param options - Optional request configuration
+     *
+     * @returns The team object
+     *
+     * @throws {Error} If the team is not found or request fails
+     *
+     * @example
+     * ```typescript
+     * const team = await client.teams.get('team-123');
+     * console.log(team.name);
+     * ```
+     */
+    get(id: string, options?: RequestOptions): Promise<Team>;
+}