Class CrmApi

constructor

• new CrmApi(workspaceId: string, validateWorkspace?: boolean): CrmApi

• Parameters

  • workspaceId: string
  • OptionalvalidateWorkspace: boolean

  Returns CrmApi

endpoint

addChecklistApi

• addChecklistApi(cardId: string, data: any): Promise<ICard>

• Parameters

  • cardId: string
  • data: any

  Returns Promise<ICard>

addFollowersApi

• addFollowersApi(cardId: string, followers: string[]): Promise<string[]>

• Parameters

  • cardId: string
  • followers: string[]

  Returns Promise<string[]>

addPersonsApi

• addPersonsApi(cardId: string, persons: string[]): Promise<ICard>

• Parameters

  • cardId: string
  • persons: string[]

  Returns Promise<ICard>

addProductsApi

• addProductsApi(cardId: string, data: any): Promise<ICard>

• Parameters

  • cardId: string
  • data: any

  Returns Promise<ICard>

addTagsApi

• addTagsApi(cardId: string, tags: string[]): Promise<string[]>

• Parameters

  • cardId: string
  • tags: string[]

  Returns Promise<string[]>

batchAddProductsApi

• batchAddProductsApi(cardId: string, products: any): Promise<ICard>

• Parameters

  • cardId: string
  • products: any

  Returns Promise<ICard>

createCardApi

• createCardApi(card: IRequiredFieldsCard): Promise<ICard>

• Parameters

  • card: IRequiredFieldsCard

  Returns Promise<ICard>

getAllCards

• getAllCards(filters: IFilterCards): Promise<IPaginatedData<ICard>>

• Parameters

  • filters: IFilterCards

  Returns Promise<IPaginatedData<ICard>>

getBoardByIdApi

• getBoardByIdApi(boardId: string): Promise<IBoard>

• Parameters

  • boardId: string

  Returns Promise<IBoard>

  get data from board, to edit or any use

getBoardsApi

• getBoardsApi(
      __namedParameters: { filters: any },
  ): Promise<IPaginatedData<IBoard>>

• Parameters

  • __namedParameters: { filters: any }

  Returns Promise<IPaginatedData<IBoard>>

  get data from board, to edit or any use

getCardByIdApi

• getCardByIdApi(
      cardId: string,
      params?: { [key: string]: string | number | boolean },
  ): Promise<ICard>

• Parameters

  • cardId: string
  • Optionalparams: { [key: string]: string | number | boolean }

  Returns Promise<ICard>

getCrm

• getCrm(boardId: string, filters: IFilterCards): Promise<ICrm>

• Parameters

  • boardId: string
  • filters: IFilterCards

  Returns Promise<ICrm>

  this request returns the board with 10 cards in every lists (IFFFF THE LIST HAS CARDS), first call to open CRM, populate

getListById

• getListById(boardId: string, listId: string): Promise<IList>

• Parameters

  • boardId: string
  • listId: string

  Returns Promise<IList>

moveCardApi

• moveCardApi(cardId: string, listId: string): Promise<ICard>

• Parameters

  • cardId: string
  • listId: string

  Returns Promise<ICard>

removeCardById

• removeCardById(cardId: string): Promise<void>

• Parameters

  • cardId: string

  Returns Promise<void>

removeChecklistApi

• removeChecklistApi(cardId: string, checklistId: string): Promise<ICard>

• Parameters

  • cardId: string
  • checklistId: string

  Returns Promise<ICard>

removeFollowersApi

• removeFollowersApi(cardId: string, followers: string[]): Promise<string[]>

• Parameters

  • cardId: string
  • followers: string[]

  Returns Promise<string[]>

removePersonsApi

• removePersonsApi(cardId: string, persons: string[]): Promise<ICard>

• Parameters

  • cardId: string
  • persons: string[]

  Returns Promise<ICard>

removeProductsApi

• removeProductsApi(
      cardId: string,
      productId: string,
      code: string,
  ): Promise<ICard>

• Parameters

  • cardId: string
  • productId: string
  • code: string

  Returns Promise<ICard>

removeTagsApi

• removeTagsApi(cardId: string, tags: string[]): Promise<string[]>

• Parameters

  • cardId: string
  • tags: string[]

  Returns Promise<string[]>

updateCardById

• updateCardById(
      cardId: string,
      payload: Partial<Omit<ICard, "user"> & { user: string }>,
  ): Promise<ICard>

• Parameters

  • cardId: string
  • payload: Partial<Omit<ICard, "user"> & { user: string }>

  Returns Promise<ICard>

updateChecklistApi

• updateChecklistApi(
      cardId: string,
      checklistId: string,
      data: any,
  ): Promise<ICard>

• Parameters

  • cardId: string
  • checklistId: string
  • data: any

  Returns Promise<ICard>

updateProductsApi

• updateProductsApi(
      cardId: string,
      productId: string,
      code: string,
      data: any,
  ): Promise<ICard>

• Parameters

  • cardId: string
  • productId: string
  • code: string
  • data: any

  Returns Promise<ICard>