Class Elements

constructor

• new Elements(api: Api): Elements

• Parameters

  • api: Api

  Returns Elements

api

archive

• archive(type: string, hash: string): Promise<void>

• Parameters

  • type: string
  • hash: string

  Returns Promise<void>

archiveFile

• archiveFile(
      type: string,
      hash: string,
      organization: string,
      attribute: string,
      fileHash: string,
      method?: "delete" | "post",
  ): Promise<void>

• Parameters

  • type: string
  • hash: string
  • organization: string
  • attribute: string
  • fileHash: string
  • Optionalmethod: "delete" | "post"

  Returns Promise<void>

cloneElementTree

• cloneElementTree(
      root: string,
      organization: string,
      newParent?: string,
      cloneConfig?: CloneConfig,
      maxDepth?: number,
  ): Promise<ApiResponse<void, void>>

• Parameters

  • root: string
  • organization: string
  • OptionalnewParent: string
  • OptionalcloneConfig: CloneConfig
  • OptionalmaxDepth: number

  Returns Promise<ApiResponse<void, void>>

copyElement

• copyElement(
      newParentType: string,
      newParentHash: string,
      copiedHash: string,
  ): Promise<
      ApiResponse<
          { element: { hash: string }; links: RestApiLink[] },
          { element: { hash: string }; links: RestApiLink[] },
      >,
  >

• Parameters

  • newParentType: string
  • newParentHash: string
  • copiedHash: string

  Returns Promise<
      ApiResponse<
          { element: { hash: string }; links: RestApiLink[] },
          { element: { hash: string }; links: RestApiLink[] },
      >,
  >

create

• create(
      type: string,
      operations: Operation[],
      organization: string,
      parent?: string,
      queryParams?: Record<string, unknown>,
  ): Promise<
      ApiResponse<
          { element: { hash: string } },
          { element: { hash: string } },
      >,
  >

• Parameters

  • type: string
  • operations: Operation[]
  • organization: string
  • Optionalparent: string
  • OptionalqueryParams: Record<string, unknown>

  Returns Promise<
      ApiResponse<
          { element: { hash: string } },
          { element: { hash: string } },
      >,
  >

generateGoUrls

• generateGoUrls(count: number): Promise<ApiResponse<GoUrlsResponse>>

• Parameters

  • count: number

  Returns Promise<ApiResponse<GoUrlsResponse>>

get

• get(
      hash: string,
      type?: string,
      useCache?: boolean,
      queryParams?: ElementGetQueryParams,
  ): Promise<
      ApiResponse<
          GetElementV1Response
          | GetElementV2Response,
          MembraneGetError,
      >,
  >

• Parameters

  • hash: string
  • Optionaltype: string
  • OptionaluseCache: boolean
  • queryParams: ElementGetQueryParams = {}

  Returns Promise<
      ApiResponse<
          GetElementV1Response
          | GetElementV2Response,
          MembraneGetError,
      >,
  >

getElementHashFromQR

• getElementHashFromQR(url: string): Promise<undefined | null | string>

• Parameters

  • url: string

  Returns Promise<undefined | null | string>

getElementTypeList

• getElementTypeList(
      organization: string,
      right?: string,
      page?: number,
  ): Promise<undefined | ElementTypePrivilegesList>

• Parameters

  • organization: string
  • right: string = 'read'
  • page: number = 1

  Returns Promise<undefined | ElementTypePrivilegesList>

getElementTypes

• getElementTypes(organizationId: string, page?: number): Promise<ElementType[]>

• Parameters

  • organizationId: string
  • page: number = 1

  Returns Promise<ElementType[]>

getPrivileges

• getPrivileges(
      organization: string,
      type: string,
  ): Promise<
      ApiResponse<ElementPrivilegesResponse, ElementPrivilegesResponse>,
  >

• Parameters

  • organization: string
  • type: string

  Returns Promise<ApiResponse<ElementPrivilegesResponse, ElementPrivilegesResponse>>

getRaw

• getRaw(
      hash: string,
      type?: string,
      useCache?: boolean,
      params?: Record<string, unknown>,
  ): Promise<undefined | { element: ElementData }>

• Parameters

  • hash: string
  • type: string = '_TYPE_PLACEHOLDER'
  • OptionaluseCache: boolean
  • Optionalparams: Record<string, unknown>

  Returns Promise<undefined | { element: ElementData }>

getTemplate

• getTemplate(
      type: string,
      organization: string,
  ): Promise<ApiResponse<ElementTemplateV1, ElementTemplateV1>>

• Parameters

  • type: string
  • organization: string

  Returns Promise<ApiResponse<ElementTemplateV1, ElementTemplateV1>>

getTypeData

• getTypeData(
      type: string,
  ): Promise<ApiResponse<ElementTypeDefinition, ElementTypeDefinition>>

• Parameters

  • type: string

  Returns Promise<ApiResponse<ElementTypeDefinition, ElementTypeDefinition>>

getUserElement

• getUserElement(
      organization: string,
      type: string,
  ): Promise<
      ApiResponse<
          undefined
          | ElementDataWrapper,
          undefined | ElementDataWrapper,
      >,
  >

• Parameters

  • organization: string
  • type: string

  Returns Promise<
      ApiResponse<
          undefined
          | ElementDataWrapper,
          undefined | ElementDataWrapper,
      >,
  >

pairQr

• pairQr(
      elementHash: string,
      organizationId: string,
      url?: string,
  ): Promise<ApiResponse<void>>

• Parameters

  • elementHash: string
  • organizationId: string
  • Optionalurl: string

  Returns Promise<ApiResponse<void>>

patch

• patch(
      type: string,
      hash: string,
      operations: Operation[],
      organization: string,
      queryParams?: Record<string, unknown>,
  ): Promise<ApiResponse<void>>

• Parameters

  • type: string
  • hash: string
  • operations: Operation[]
  • organization: string
  • OptionalqueryParams: Record<string, unknown>

  Returns Promise<ApiResponse<void>>

search

• search(query: string, options?: ElementSearchOptions): Promise<GetElementSearch>

• Parameters

  • query: string
  • Optionaloptions: ElementSearchOptions

  Returns Promise<GetElementSearch>

setParent

• setParent(
      type: string,
      hash: string,
      parentHash: string,
  ): Promise<ApiResponse<void>>

• Parameters

  • type: string
  • hash: string
  • parentHash: string

  Returns Promise<ApiResponse<void>>

startChecklist

• startChecklist(
      data: StartChecklistData,
  ): Promise<
      ApiResponse<
          StartChecklistResponse,
          { error: { code: string; description: string } },
      >,
  >

• Parameters

  • data: StartChecklistData

  Returns Promise<
      ApiResponse<
          StartChecklistResponse,
          { error: { code: string; description: string } },
      >,
  >

unarchive

• unarchive(type: string, hash: string): Promise<void>

• Parameters

  • type: string
  • hash: string

  Returns Promise<void>