@or-sdk/idw 8.2.2 → 8.3.0-beta.4080.0

package/src/index.ts

@@ -1,5 +1,25 @@
-export * from './api';
+export { IdwClient } from './IdwClient';
+export { SERVICE_KEY } from './constants';
+export * from './schemas';
 export * from './types';
-export { IdwApi } from './idwApi';
-export { IdwApiV2 } from './idwApiV2';
-export * from './constants';
+
+export { AccountApi } from './modules/AccountApi';
+export { ChatApi } from './modules/ChatApi';
+export { DatasourcesApi } from './modules/DatasourcesApi';
+export { DatasourceSelectionsApi } from './modules/DatasourceSelectionsApi';
+export { DomainsApi } from './modules/DomainsApi';
+export { FeedApi } from './modules/FeedApi';
+export { FilesApi } from './modules/FilesApi';
+export { IdwApi } from './modules/IdwApi';
+export { IdwSettingsApi } from './modules/IdwSettingsApi';
+export { IdwSystemApi } from './modules/IdwSystemApi';
+export { IdwUserApi } from './modules/IdwUserApi';
+export { InstallerApi } from './modules/InstallerApi';
+export { KnowledgeApi } from './modules/KnowledgeApi';
+export { LookupApi } from './modules/LookupApi';
+export { ReportingApi } from './modules/ReportingApi';
+export { SkillsApi } from './modules/SkillsApi';
+export { SystemApi } from './modules/SystemApi';
+export { UserInfoApi } from './modules/UserInfoApi';
+
+export type { IdwHttpClient } from './IdwHttpClient';

package/src/modules/AccountApi.ts

@@ -0,0 +1,15 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import type { IdwDto } from '../types/idw';
+import type { QueryAccountId } from '../types/user';
+
+export class AccountApi {
+  constructor(private readonly client: IdwHttpClient) {}
+
+  listAccountIdws(params?: QueryAccountId): Promise<IdwDto[]> {
+    return this.client.makeRequest<IdwDto[]>({
+      route: 'account/idws',
+      method: 'GET',
+      params,
+    });
+  }
+}

package/src/modules/ChatApi.ts

@@ -0,0 +1,109 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  ChatCreateDto,
+  ChatDto,
+  ChatMessageDto,
+  ChatModelsPatchDto,
+  ChatPatchDto,
+  ChatSkillDto,
+  ChatsListQueryDto,
+  CreateChatSkillDto,
+} from '../types/chat';
+
+export class ChatApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private chatBase(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'chat');
+  }
+
+  private chatSkillsBase(chatId: string): string {
+    return `${this.chatBase()}/${encodeURIComponent(chatId)}/skills`;
+  }
+
+  listChats(params?: ChatsListQueryDto): Promise<ChatDto[]> {
+    return this.client.makeRequest<ChatDto[]>({
+      route: `${this.chatBase()}/list`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  createChat(data: ChatCreateDto): Promise<ChatDto> {
+    return this.client.makeRequest<ChatDto>({
+      route: `${this.chatBase()}/new`,
+      method: 'POST',
+      data,
+    });
+  }
+
+  getChat(chatId: string): Promise<ChatDto> {
+    return this.client.makeRequest<ChatDto>({
+      route: `${this.chatBase()}/${encodeURIComponent(chatId)}`,
+      method: 'GET',
+    });
+  }
+
+  updateChat(chatId: string, data: ChatPatchDto): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.chatBase()}/${encodeURIComponent(chatId)}`,
+      method: 'PATCH',
+      data,
+    });
+  }
+
+  updateChatModels(chatId: string, data: ChatModelsPatchDto): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.chatBase()}/${encodeURIComponent(chatId)}/models`,
+      method: 'PATCH',
+      data,
+    });
+  }
+
+  deleteChat(chatId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.chatBase()}/${encodeURIComponent(chatId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  getChatMessages(chatId: string): Promise<ChatMessageDto[]> {
+    return this.client.makeRequest<ChatMessageDto[]>({
+      route: `${this.chatBase()}/${encodeURIComponent(chatId)}/messages`,
+      method: 'GET',
+    });
+  }
+
+  listChatSkills(chatId: string): Promise<ChatSkillDto[]> {
+    return this.client.makeRequest<ChatSkillDto[]>({
+      route: this.chatSkillsBase(chatId),
+      method: 'GET',
+    });
+  }
+
+  attachChatSkill(chatId: string, data: CreateChatSkillDto): Promise<ChatSkillDto> {
+    return this.client.makeRequest<ChatSkillDto>({
+      route: this.chatSkillsBase(chatId),
+      method: 'POST',
+      data,
+    });
+  }
+
+  deleteChatSkill(chatId: string, skillSessionId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.chatSkillsBase(chatId)}/${encodeURIComponent(skillSessionId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  touchChatSkill(chatId: string, skillSessionId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.chatSkillsBase(chatId)}/${encodeURIComponent(skillSessionId)}/touch`,
+      method: 'PATCH',
+    });
+  }
+}

package/src/modules/DatasourceSelectionsApi.ts

@@ -0,0 +1,29 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type { DatasourceSelectionDto, DatasourceSelectionResponse } from '../types/datasource-selections';
+
+export class DatasourceSelectionsApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'datasource-selections');
+  }
+
+  getUserSelections(): Promise<DatasourceSelectionResponse> {
+    return this.client.makeRequest<DatasourceSelectionResponse>({
+      route: this.base(),
+      method: 'GET',
+    });
+  }
+
+  saveUserSelections(data: DatasourceSelectionDto): Promise<DatasourceSelectionResponse> {
+    return this.client.makeRequest<DatasourceSelectionResponse>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+}

package/src/modules/DatasourcesApi.ts

@@ -0,0 +1,77 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute, resolveIdwId } from '../resolveIdwId';
+import type {
+  CreateDatasourceDto,
+  DatasourceDto,
+  FilterDatasourcesDto,
+  UpdateDatasourceDto,
+  UpdateDatasourceStatusDto,
+} from '../types/datasources';
+
+export class DatasourcesApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'datasources');
+  }
+
+  listDatasources(params?: FilterDatasourcesDto): Promise<DatasourceDto[]> {
+    return this.client.makeRequest<DatasourceDto[]>({
+      route: this.base(),
+      method: 'GET',
+      params,
+    });
+  }
+
+  getDatasource(datasourceId: string): Promise<DatasourceDto> {
+    return this.client.makeRequest<DatasourceDto>({
+      route: `${this.base()}/${encodeURIComponent(datasourceId)}`,
+      method: 'GET',
+    });
+  }
+
+  createDatasource(data: CreateDatasourceDto): Promise<DatasourceDto> {
+    return this.client.makeRequest<DatasourceDto>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+
+  updateDatasource(datasourceId: string, data: UpdateDatasourceDto): Promise<DatasourceDto> {
+    return this.client.makeRequest<DatasourceDto>({
+      route: `${this.base()}/${encodeURIComponent(datasourceId)}`,
+      method: 'PATCH',
+      data,
+    });
+  }
+
+  updateDatasourceStatus(
+    datasourceId: string,
+    data: UpdateDatasourceStatusDto,
+  ): Promise<DatasourceDto> {
+    return this.client.makeRequest<DatasourceDto>({
+      route: `${this.base()}/${encodeURIComponent(datasourceId)}/status`,
+      method: 'PATCH',
+      data,
+    });
+  }
+
+  deleteDatasource(datasourceId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(datasourceId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  listDatasourcesForAdmin(): Promise<DatasourceDto[]> {
+    const id = resolveIdwId(this.client, this.idwIdOverride);
+    return this.client.makeRequest<DatasourceDto[]>({
+      route: `idw/${encodeURIComponent(id)}/admin/datasources`,
+      method: 'GET',
+    });
+  }
+}

package/src/modules/DomainsApi.ts

@@ -0,0 +1,72 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  CreateDomainParams,
+  CreateDomainResponse,
+  DomainDto,
+  DomainListResponse,
+  DomainWithCountDto,
+  DomainWithCountListResponse,
+} from '../types/domains';
+
+export class DomainsApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'domains');
+  }
+
+  listDomains(): Promise<DomainListResponse> {
+    return this.client.makeRequest<DomainListResponse>({
+      route: this.base(),
+      method: 'GET',
+    });
+  }
+
+  listDomainsWithNotesCount(): Promise<DomainWithCountListResponse> {
+    return this.client.makeRequest<DomainWithCountListResponse>({
+      route: `${this.base()}/notes-count`,
+      method: 'GET',
+    });
+  }
+
+  getDomain(domainId: string): Promise<DomainDto> {
+    return this.client.makeRequest<DomainDto>({
+      route: `${this.base()}/${encodeURIComponent(domainId)}`,
+      method: 'GET',
+    });
+  }
+
+  getDomainWithNotesCount(domainId: string): Promise<DomainWithCountDto> {
+    return this.client.makeRequest<DomainWithCountDto>({
+      route: `${this.base()}/${encodeURIComponent(domainId)}/notes-count`,
+      method: 'GET',
+    });
+  }
+
+  deleteDomain(domainId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(domainId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  createDomain(data: CreateDomainParams): Promise<CreateDomainResponse> {
+    return this.client.makeRequest<CreateDomainResponse>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+
+  updateDomain(domainId: string, data: CreateDomainParams): Promise<CreateDomainResponse> {
+    return this.client.makeRequest<CreateDomainResponse>({
+      route: `${this.base()}/${encodeURIComponent(domainId)}`,
+      method: 'PATCH',
+      data,
+    });
+  }
+}

package/src/modules/FeedApi.ts

@@ -0,0 +1,149 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  AddCommentParams,
+  CommentResponse,
+  CreateFeedParams,
+  CreateFeedResult,
+  FeedItem,
+  FeedMarkReadResponse,
+  FeedReadHistoryRecord,
+  FeedUnreadStatus,
+  FeedUpdateDto,
+  ListCommentsParams,
+  ListFeedQuery,
+  ListFeedResponse,
+  ReactionResponse,
+  UpdateCommentParams,
+} from '../types/feed';
+
+export class FeedApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'feeds');
+  }
+
+  listComments(params: ListCommentsParams): Promise<CommentResponse[]> {
+    return this.client.makeRequest<CommentResponse[]>({
+      route: `${this.base()}/comments`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  listFeeds(params?: ListFeedQuery): Promise<ListFeedResponse> {
+    return this.client.makeRequest<ListFeedResponse>({
+      route: this.base(),
+      method: 'GET',
+      params,
+    });
+  }
+
+  getFeedById(feedId: string): Promise<FeedItem> {
+    return this.client.makeRequest<FeedItem>({
+      route: `${this.base()}/${encodeURIComponent(feedId)}`,
+      method: 'GET',
+    });
+  }
+
+  createFeed(data: CreateFeedParams): Promise<CreateFeedResult> {
+    return this.client.makeRequest<CreateFeedResult>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+
+  updateFeed(data: FeedUpdateDto): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: this.base(),
+      method: 'PUT',
+      data,
+    });
+  }
+
+  deleteFeed(feedId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(feedId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  addComment(data: AddCommentParams): Promise<CommentResponse> {
+    return this.client.makeRequest<CommentResponse>({
+      route: `${this.base()}/comments`,
+      method: 'POST',
+      data,
+    });
+  }
+
+  updateComment(data: UpdateCommentParams): Promise<CommentResponse> {
+    return this.client.makeRequest<CommentResponse>({
+      route: `${this.base()}/comments`,
+      method: 'PUT',
+      data,
+    });
+  }
+
+  deleteComment(commentId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/comments/${encodeURIComponent(commentId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  listReactions(feedId: string): Promise<ReactionResponse[]> {
+    return this.client.makeRequest<ReactionResponse[]>({
+      route: `${this.base()}/reactions/${encodeURIComponent(feedId)}`,
+      method: 'GET',
+    });
+  }
+
+  addReaction(data: AddCommentParams): Promise<ReactionResponse> {
+    return this.client.makeRequest<ReactionResponse>({
+      route: `${this.base()}/reactions`,
+      method: 'POST',
+      data,
+    });
+  }
+
+  deleteReaction(reactionId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/reactions/${encodeURIComponent(reactionId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  markAllPostsAsRead(): Promise<FeedMarkReadResponse> {
+    return this.client.makeRequest<FeedMarkReadResponse>({
+      route: `${this.base()}/read-history/mark-all`,
+      method: 'POST',
+    });
+  }
+
+  markPostAsRead(feedId: string): Promise<FeedReadHistoryRecord> {
+    return this.client.makeRequest<FeedReadHistoryRecord>({
+      route: `${this.base()}/read-history/${encodeURIComponent(feedId)}`,
+      method: 'POST',
+    });
+  }
+
+  hasUnreadPosts(): Promise<FeedUnreadStatus> {
+    return this.client.makeRequest<FeedUnreadStatus>({
+      route: `${this.base()}/read-history/has-unread`,
+      method: 'GET',
+    });
+  }
+
+  enhanceFeedContent(content: string): Promise<string> {
+    return this.client.makeRequest<string>({
+      route: `${this.base()}/enhance-content`,
+      method: 'POST',
+      data: { content },
+    });
+  }
+}

package/src/modules/FilesApi.ts

@@ -0,0 +1,14 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import type { ParseDocumentBody, ParseFileResponse } from '../types/files';
+
+export class FilesApi {
+  constructor(private readonly client: IdwHttpClient) {}
+
+  parseFile(data: ParseDocumentBody): Promise<ParseFileResponse> {
+    return this.client.makeRequest<ParseFileResponse>({
+      route: 'files',
+      method: 'POST',
+      data,
+    });
+  }
+}

package/src/modules/IdwApi.ts

@@ -0,0 +1,35 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { resolveIdwId } from '../resolveIdwId';
+import type { IdwDto, IdwInfoDto, UpdateIdwDto } from '../types/idw';
+
+export class IdwApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  getIdw(): Promise<IdwDto> {
+    const id = resolveIdwId(this.client, this.idwIdOverride);
+    return this.client.makeRequest<IdwDto>({
+      route: `idw/${encodeURIComponent(id)}`,
+      method: 'GET',
+    });
+  }
+
+  getIdwInfo(): Promise<IdwInfoDto | null> {
+    const id = resolveIdwId(this.client, this.idwIdOverride);
+    return this.client.makeRequest<IdwInfoDto | null>({
+      route: `idw/${encodeURIComponent(id)}/info`,
+      method: 'GET',
+    });
+  }
+
+  updateIdw(data: UpdateIdwDto): Promise<IdwDto> {
+    const id = resolveIdwId(this.client, this.idwIdOverride);
+    return this.client.makeRequest<IdwDto>({
+      route: `idw/${encodeURIComponent(id)}`,
+      method: 'PATCH',
+      data,
+    });
+  }
+}

package/src/modules/IdwSettingsApi.ts

@@ -0,0 +1,51 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  SetAccessSettingsDto,
+  SetCoreSettingsDto,
+  SetSignUpSettingsDto,
+  SetWelcomeScreenSettingsDto,
+} from '../types/idw';
+
+export class IdwSettingsApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  setCoreSettings(data: SetCoreSettingsDto): Promise<void> {
+    const route = `${idwScopedRoute(this.client, this.idwIdOverride, 'settings')}/core`;
+    return this.client.makeRequest<void>({
+      route,
+      method: 'POST',
+      data,
+    });
+  }
+
+  setAccessSettings(data: SetAccessSettingsDto): Promise<void> {
+    const route = `${idwScopedRoute(this.client, this.idwIdOverride, 'settings')}/access`;
+    return this.client.makeRequest<void>({
+      route,
+      method: 'POST',
+      data,
+    });
+  }
+
+  setSignUpSettings(data: SetSignUpSettingsDto): Promise<void> {
+    const route = `${idwScopedRoute(this.client, this.idwIdOverride, 'settings')}/signup`;
+    return this.client.makeRequest<void>({
+      route,
+      method: 'POST',
+      data,
+    });
+  }
+
+  setWelcomeScreenSettings(data: SetWelcomeScreenSettingsDto): Promise<void> {
+    const route = `${idwScopedRoute(this.client, this.idwIdOverride, 'settings')}/welcome-screen`;
+    return this.client.makeRequest<void>({
+      route,
+      method: 'POST',
+      data,
+    });
+  }
+}

package/src/modules/IdwSystemApi.ts

@@ -0,0 +1,28 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import type { CreateIdwDto, IdwDto } from '../types/idw';
+
+export class IdwSystemApi {
+  constructor(private readonly client: IdwHttpClient) {}
+
+  createIdw(data: CreateIdwDto): Promise<IdwDto> {
+    return this.client.makeRequest<IdwDto>({
+      route: 'idw',
+      method: 'POST',
+      data,
+    });
+  }
+
+  listIdws(): Promise<IdwDto[]> {
+    return this.client.makeRequest<IdwDto[]>({
+      route: 'idw',
+      method: 'GET',
+    });
+  }
+
+  deleteIdw(idwId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `idw/${encodeURIComponent(idwId)}`,
+      method: 'DELETE',
+    });
+  }
+}

package/src/modules/IdwUserApi.ts

@@ -0,0 +1,51 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  CurrentProfile,
+  QueryAccountId,
+  UserDetailsQuery,
+  UserDetaulsResponse,
+} from '../types/user';
+
+export class IdwUserApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'user');
+  }
+
+  getUserDetails(params?: UserDetailsQuery): Promise<UserDetaulsResponse> {
+    return this.client.makeRequest<UserDetaulsResponse>({
+      route: `${this.base()}/details`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  /** SVG markup (`image/svg+xml`). */
+  getLogo(params?: QueryAccountId): Promise<string> {
+    return this.client.makeRequest<string>({
+      route: `${this.base()}/logo`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  updateContact(data: CurrentProfile): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/contact`,
+      method: 'POST',
+      data,
+    });
+  }
+
+  getContactId(): Promise<string> {
+    return this.client.makeRequest<string>({
+      route: `${this.base()}/contact-id`,
+      method: 'GET',
+    });
+  }
+}

package/src/modules/InstallerApi.ts

@@ -0,0 +1,20 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type { InstallSpaceDto } from '../types/installer';
+import type { CreateSkillResponse } from '../types/skills';
+
+export class InstallerApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  installSpace(data: InstallSpaceDto): Promise<CreateSkillResponse> {
+    const route = idwScopedRoute(this.client, this.idwIdOverride, 'installer');
+    return this.client.makeRequest<CreateSkillResponse>({
+      route,
+      method: 'POST',
+      data,
+    });
+  }
+}