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

package/src/idwApiV2.ts

@@ -1,725 +0,0 @@
-import { Base } from '@or-sdk/base';
-
-import { SERVICE_KEYV2 } from './constants';
-import {
-  DatasourceWithModel,
-  DatasourceWithModelPayload,
-  DatasourceWithModelResponse,
-  EditSkillParams,
-  Feed,
-  IdwSettings,
-  Knowledge,
-  KnowledgeCreateData,
-  KnowledgeUpdateData,
-  CoreBody,
-  AccessBody,
-  SignUpBody,
-  WelcomeScreenBody,
-} from './types';
-import {
-  IDWV2ApiConfig,
-  GetGlobalFiltersResponse,
-  GetTotalSessionsResponse,
-  SkillItem,
-  ReportingRangeParams,
-
-  // Models
-  ListModelsResponse,
-
-  // User details
-  GetUserDetailsParams,
-  GetUserDetailsResponse,
-  GetUsersInquiresResponse,
-  GetUsersSessionsResponse,
-
-  // News feed
-  CreateFeedParams,
-  ListFeedsParams,
-  ListFeedsResponse,
-  UpdateFeedParams,
-
-  // News feed reactions
-  FeedReaction,
-  AddReactionParams,
-
-  // News feed comments
-  FeedComment,
-  FeedWithComment,
-  AddCommentParams,
-  ListCommentsParams,
-  UpdateCommentParams,
-
-  // News feed read history
-  FeedHistoryResponse,
-  FeedHistoryInfoResponse,
-
-  // IDW Domains
-  IdwDomain,
-  IdwDomainsListResponse,
-  CreateSkillParams,
-  CreateSkillResponse,
-  CreateDomainData,
-  CreateDomainResponse,
-  CheckSkillAccessParams,
-} from './types/idwV2';
-
-export class IdwApiV2 extends Base {
-  private _token: string | (() => string) | undefined;
-  private _ortoken: string | (() => string) | undefined;
-
-  constructor(params: IDWV2ApiConfig) {
-    const { token, discoveryUrl, accountId, idwApiUrl, ortoken } = params;
-    super({
-      token: 'false',
-      discoveryUrl,
-      serviceKey: SERVICE_KEYV2,
-      accountId,
-      serviceUrl: idwApiUrl,
-    });
-    this._token = token;
-    this._ortoken = ortoken;
-  }
-
-  protected getHeaders() {
-    let token;
-    let ortoken;
-
-    if (typeof this._token === 'string') {
-      token = this._token;
-    }
-    if (typeof this._token === 'function') {
-      token = this._token();
-    }
-
-    if (typeof this._ortoken === 'string') {
-      ortoken = this._ortoken;
-    }
-    if (typeof this._ortoken === 'function') {
-      ortoken = this._ortoken();
-    }
-    return {
-      'Content-Type': 'application/json;charset=UTF-8',
-      ... token ? { Authorization: token } : {},
-      ... ortoken ? { ortoken } : {},
-    };
-  }
-
-  /**
-   * @description List skills
-   * @param accountId
-   */
-  getIdwInfo(accountId: string): Promise<IdwSettings> {
-    return this.callApiV2({
-      route: 'user/info',
-      params: {
-        accountId,
-      },
-    });
-  }
-
-  /**
-   * @description Set IDW core info
-   * @param accountId
-   * @param data
-   */
-  setCoreBody(accountId: string, data: CoreBody): Promise<void> {
-    return this.callApiV2({
-      route: 'user/core',
-      method: 'post',
-      params: {
-        accountId,
-      },
-      data,
-    });
-  }
-
-  /**
-   * @description Set IDW access
-   * @param accountId
-   * @param data
-   */
-  setAccessBody(accountId: string, data: AccessBody): Promise<void> {
-    return this.callApiV2({
-      route: 'user/access',
-      method: 'post',
-      params: {
-        accountId,
-      },
-      data,
-    });
-  }
-
-  /**
-   * @description Set IDW signup screen
-   * @param accountId
-   * @param data
-   */
-  setSignUpBody(accountId: string, data: SignUpBody): Promise<void> {
-    return this.callApiV2({
-      route: 'user/signup',
-      method: 'post',
-      params: {
-        accountId,
-      },
-      data,
-    });
-  }
-
-  /**
-   * @description Set IDW Chat welcome screen
-   * @param accountId
-   * @param data
-   */
-  setWelcomeScreenBody(accountId: string, data: WelcomeScreenBody): Promise<void> {
-    return this.callApiV2({
-      route: 'user/chat',
-      method: 'post',
-      params: {
-        accountId,
-      },
-      data,
-    });
-  }
-
-  /**
- * @description List skills
- * @param accountId
- */
-  listSkills(accountId?: string): Promise<SkillItem[]> {
-    return this.callApiV2({
-      route: 'skills',
-      params: {
-        accountId,
-      },
-    });
-  }
-
-  /**
-   * @description Get user details
-   * @param params {skipContact: boolean; requestId: string;}
-   */
-  getUserDetails(params: GetUserDetailsParams = {}): Promise<GetUserDetailsResponse> {
-    return this.callApiV2({
-      route: 'user/details',
-      params,
-    });
-  }
-
-  /**
-   * @description Get contact id
-   */
-  getContactID(): Promise<string> {
-    return this.callApiV2({
-      route: 'user/contact-id',
-    });
-  }
-
-  /**
-   * @description List models and user selections
-   * @param accountId
-   */
-  listModels(accountId?: string): Promise<ListModelsResponse> {
-    return this.callApiV2({
-      route: 'models',
-      params: {
-        accountId,
-      },
-    });
-  }
-
-  /**
-   * @description List feeds
-   * @param params
-   */
-  listFeeds(params: ListFeedsParams): Promise<ListFeedsResponse> {
-    return this.callApiV2({
-      route: 'feeds',
-      params,
-    });
-  }
-
-  /**
-   * @description Get feed by id
-   * @param id
-   * @param accountId
-   */
-  getFeedById(id: string, accountId?: string): Promise<FeedWithComment> {
-    return this.callApiV2({
-      route: `feeds/${id}`,
-      params: { accountId },
-    });
-  }
-
-  /**
-   * @description Create feed
-   * @param data
-   */
-  createFeed(data: CreateFeedParams): Promise<Feed> {
-    return this.callApiV2({
-      route: 'feeds',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @description Update feed
-   * @param data
-   */
-  updateFeed(data: UpdateFeedParams): Promise<Feed> {
-    return this.callApiV2({
-      route: 'feeds',
-      method: 'put',
-      data,
-    });
-  }
-
-  /**
-   * @description Delete feed
-   * @param id
-   */
-  deleteFeed(id: string): Promise<void> {
-    return this.callApiV2({
-      route: `feeds/${id}`,
-      method: 'delete',
-    });
-  }
-
-  /**
-   * @description Improve content by AI
-   * @param data
-   */
-  enhancePostContent(data: { content: string }): Promise<{ content: string }> {
-    return this.callApiV2({
-      route: 'feeds/enhance-content',
-      method: 'post',
-      data,
-    });
-  }
-
-
-  /**
-   * @description Reporting get users inquires
-   * @param data
-   */
-  getUsersInquires(data: ReportingRangeParams): Promise<GetUsersInquiresResponse> {
-    return this.callApiV2({
-      route: 'reporting/users-inquires',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @description Reporting get users sessions
-   * @param data
-   */
-  getUsersSessions(data: ReportingRangeParams): Promise<GetUsersSessionsResponse> {
-    return this.callApiV2({
-      route: 'reporting/users-sessions',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @description Reporting get total sessions by skill
-   * @param data
-   */
-  getTotalSessions(data: ReportingRangeParams): Promise<GetTotalSessionsResponse[]> {
-    return this.callApiV2({
-      route: 'reporting/total-sessions-by-skill',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @description Reporting get global filters
-   */
-  getGlobalFilters(): Promise<GetGlobalFiltersResponse> {
-    return this.callApiV2({
-      route: 'reporting/global-filters',
-    });
-  }
-
-  /**
-   * @param params
-   * @description List comments by feed id
-   */
-  listComments(params: ListCommentsParams): Promise<FeedComment[]> {
-    return this.callApiV2({
-      route: 'feeds/comments',
-      params,
-    });
-  }
-
-  /**
-   * @param data
-   * @description Add comment
-   */
-  addComment(data: AddCommentParams): Promise<FeedComment> {
-    return this.callApiV2({
-      route: 'feeds/comments',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @param data
-   * @description Update comment
-   */
-  updateComment(data: UpdateCommentParams): Promise<void> {
-    return this.callApiV2({
-      route: 'feeds/comments',
-      method: 'put',
-      data,
-    });
-  }
-
-  /**
-   * @param id
-   * @description Delete comment
-   */
-  deleteComment(id: string): Promise<void> {
-    return this.callApiV2({
-      route: `feeds/comments/${id}`,
-      method: 'delete',
-    });
-  }
-
-  /**
-   * @param id
-   * @description List reactions by feed id
-   */
-  listReactions(id: string): Promise<FeedReaction[]> {
-    return this.callApiV2({
-      route: `feeds/reactions/${id}`,
-    });
-  }
-
-  /**
-   * @param data
-   * @description Add reaction
-   */
-  addReaction(data: AddReactionParams): Promise<FeedReaction> {
-    return this.callApiV2({
-      route: 'feeds/reactions',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @param id
-   * @description Delete reaction
-   */
-  deleteReaction(id: string): Promise<void> {
-    return this.callApiV2({
-      route: `feeds/reactions/${id}`,
-      method: 'delete',
-    });
-  }
-
-  /**
-   * @description Get domains list
-   */
-  getDomains(): Promise<IdwDomainsListResponse> {
-    return this.callApiV2({
-      route: 'domains',
-      method: 'get',
-    });
-  }
-
-  /**
-   * @param id
-   * @description Get domain info
-   */
-  getDomainById(id: string): Promise<IdwDomain> {
-    return this.callApiV2({
-      route: `domains/${id}`,
-      method: 'get',
-    });
-  }
-
-
-  /**
-   * @description Check has a current user unread posts or not
-   */
-  hasUnreadPosts(): Promise<FeedHistoryInfoResponse> {
-    return this.callApiV2({
-      route: 'feeds/read-history/has-unread',
-      method: 'get',
-    });
-  }
-
-  /**
-   * @description Mark news feed post as read by current user
-   * @param id
-   */
-  markPostAsRead(id: string): Promise<FeedHistoryResponse> {
-    return this.callApiV2({
-      route: `feeds/read-history/${id}`,
-      method: 'post',
-    });
-  }
-
-  /**
-   * @description Mark all news feed posts as read by current user
-   */
-  markAllPostsAsRead(): Promise<void> {
-    return this.callApiV2({
-      route: 'feeds/read-history/mark-all',
-      method: 'post',
-    });
-  }
-
-  //region Knowledge methods */
-
-  /**
-   * @description Get one knowledge
-   */
-  getOneKnowledge(id: string): Promise<Knowledge> {
-    return this.callApiV2({
-      route: `knowledge/${id}`,
-      method: 'get',
-    });
-  }
-
-  /**
-   * @description Get all knowledge
-   */
-  getAllKnowledge(): Promise<{ data: Knowledge[]; meta: {
-    limit: number;
-    page: number;
-    totalItems: number;
-    totalPages: number;
-  }; }> {
-    return this.callApiV2({
-      route: 'knowledge',
-      method: 'get',
-    });
-  }
-
-  /**
-   * @description Create new knowledge
-   */
-  createKnowledge(data: KnowledgeCreateData): Promise<Knowledge> {
-    return this.callApiV2({
-      route: 'knowledge',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   * @description Update existence knowledge
-   */
-  updateKnowledge(data: KnowledgeUpdateData): Promise<Knowledge> {
-    return this.callApiV2({
-      route: `knowledge/${data.knowledge_id}`,
-      method: 'put',
-      data,
-    });
-  }
-
-  /**
-   * @description Delete knowledge
-  */
-  deleteKnowledge(id: string): Promise<void> {
-    return this.callApiV2({
-      route: `knowledge/${id}`,
-      method: 'delete',
-    });
-  }
-  //endregion
-
-  /**
-   *
-   * @param data
-   * @description Create skill
-   */
-  createSkill(data: CreateSkillParams): Promise<CreateSkillResponse> {
-    return this.callApiV2({
-      route: 'skills',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   *
-   * @param data
-   * @description Edit skill
-   */
-  editSkill(data: EditSkillParams): Promise<CreateSkillResponse> {
-    return this.callApiV2({
-      route: `skills/${data.skill.id}`,
-      method: 'patch',
-      data,
-    });
-  }
-
-  /**
-   *
-   * @param id string
-   * @description Delete skill
-   */
-  deleteSkill(id: string): Promise<void> {
-    return this.callApiV2({
-      route: `skills/${id}`,
-      method: 'delete',
-    });
-  }
-
-  /**
-   *
-   * @param data
-   * @description Check skill access
-  */
-  checkSkillAccess(data: CheckSkillAccessParams): Promise<SkillItem> {
-    return this.callApiV2({
-      route: 'skills/access',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   *
-   * @description Sync feed, knowledge, domains, skills to graph db
-   */
-  syncGraph() {
-    return this.callApiV2({
-      route: 'sync-graph',
-      method: 'post',
-    });
-  }
-
-  /**
-   *
-   * @param data {domain: {name},skills:[id]}
-   * @description Create domain and attach skills
-   */
-
-  createDomain(data: CreateDomainData): Promise<CreateDomainResponse> {
-    return this.callApiV2({
-      route: 'domains',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   *
-   * @param id string
-   * @param data {domain: {name},skills:[id]}
-   * @description Edit domain and reattach skills
-   */
-
-  editDomain(id: string, data: CreateDomainData): Promise<CreateDomainResponse> {
-    return this.callApiV2({
-      route: `domains/${id}`,
-      method: 'patch',
-      data,
-    });
-  }
-
-  /**
-   *
-   * @param id string
-   * @description Delete domain by id
-   */
-
-  deleteDomain(id: string): Promise<void> {
-    return this.callApiV2({
-      route: `domains/${id}`,
-      method: 'delete',
-    });
-  }
-
-  /**
-   *
-   * @description Get all datasources
-   */
-  listDatasources(accountId?: string): Promise<DatasourceWithModel[]> {
-    return this.callApiV2({
-      route: 'datasources',
-      method: 'get',
-      params: { accountId },
-    });
-  }
-
-  /**
-   *
-   * @param data
-   * @description Create datasource, model and link datasource with model
-   */
-  createDatasourceWithModel(data: DatasourceWithModelPayload): Promise<DatasourceWithModelResponse> {
-    return this.callApiV2({
-      route: 'datasources',
-      method: 'post',
-      data,
-    });
-  }
-
-  /**
-   *
-   * @param id datasource id
-   * @param data
-   * @description Edit datasource and model
-   */
-  editDatasourceWithModel(id: string, data: DatasourceWithModelPayload): Promise<DatasourceWithModelResponse> {
-    return this.callApiV2({
-      route: `datasources/${id}`,
-      method: 'patch',
-      data,
-    });
-  }
-
-  /**
-   * @param id datasource id
-   * @param status is datasource should be enabled or disabled
-   * @description Edit datasource and model
-   */
-  setDatasourceStatus(id: string, status: boolean): Promise<DatasourceWithModelResponse> {
-    return this.callApiV2({
-      route: `datasources/${id}/status`,
-      method: 'patch',
-      data: {
-        enabled: status,
-      },
-    });
-  }
-
-  /**
-   *
-   * @param id datasource id
-   * @description Delete datasource, model and relation between
-   */
-  deleteDatasourceWithModel(id: string): Promise<DatasourceWithModelResponse> {
-    return this.callApiV2({
-      route: `datasources/${id}`,
-      method: 'delete',
-    });
-  }
-
-  /**
-   *
-   * @param method method name
-   * @param args array of arguments
-   * @description call lookup for anonymous users
-   */
-  lookupProxy(method: string, args: unknown[], accountId?: string) {
-    return this.callApiV2({
-      route: 'lookup/proxy',
-      method: 'post',
-      data: {
-        method,
-        args,
-      },
-      params: { accountId },
-    });
-  }
-}