Class Elements

constructor

• new Elements(api): Elements

• Parameters

  • api: Api

  Returns Elements

api

archive

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

• Parameters

  • type: string

  • hash: string

  Returns Promise<void>

archiveFile

• archiveFile(type, hash, organization, attribute, fileHash, method?): Promise<void>

• Parameters

  • type: string

  • hash: string

  • organization: string

  • attribute: string

  • fileHash: string

  • Optional method: "delete" | "post"

  Returns Promise<void>

cloneElementTree

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

• Parameters

  • root: string

  • organization: string

  • Optional newParent: string

  • Optional cloneConfig: CloneConfig

  • Optional maxDepth: number

  Returns Promise<ApiResponse<void, void>>

copyElement

• copyElement(newParentType, newParentHash, copiedHash): 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, operations, organization, parent?, queryParams?): Promise<ApiResponse<{
      element: {
          hash: string;
      };
  }, {
      element: {
          hash: string;
      };
  }>>

• Parameters

  • type: string

  • operations: Operation[]

  • organization: string

  • Optional parent: string

  • Optional queryParams: Record<string, unknown>

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

generateGoUrls

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

• Parameters

  • count: number

  Returns Promise<ApiResponse<GoUrlsResponse>>

get

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

• Parameters

  • hash: string

  • Optional type: string

  • Optional useCache: boolean

  • queryParams: ElementGetQueryParams = {}

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

getElementHashFromQR

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

• Parameters

  • url: string

  Returns Promise<undefined | null | string>

getElementTypeList

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

• Parameters

  • organization: string

  • right: string = 'read'

  • page: number = 1

  Returns Promise<undefined | ElementTypePrivilegesList>

getElementTypes

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

• Parameters

  • organizationId: string

  • page: number = 1

  Returns Promise<ElementType[]>

getPrivileges

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

• Parameters

  • organization: string

  • type: string

  Returns Promise<ApiResponse<ElementPrivilegesResponse, ElementPrivilegesResponse>>

getRaw

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

• Parameters

  • hash: string

  • type: string = '_TYPE_PLACEHOLDER'

  • Optional useCache: boolean

  • Optional params: Record<string, unknown>

  Returns Promise<undefined | {
      element: ElementData;
  }>

getTemplate

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

• Parameters

  • type: string

  • organization: string

  Returns Promise<ApiResponse<ElementTemplateV1, ElementTemplateV1>>

getTypeData

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

• Parameters

  • type: string

  Returns Promise<ApiResponse<ElementTypeDefinition, ElementTypeDefinition>>

pairQr

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

• Parameters

  • elementHash: string

  • organizationId: string

  • Optional url: string

  Returns Promise<ApiResponse<void>>

patch

• patch(type, hash, operations, organization, queryParams?): Promise<ApiResponse<void>>

• Parameters

  • type: string

  • hash: string

  • operations: Operation[]

  • organization: string

  • Optional queryParams: Record<string, unknown>

  Returns Promise<ApiResponse<void>>

search

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

• Parameters

  • query: string

  • username: string

  • Optional options: ElementSearchOptions

  Returns Promise<GetElementSearch>

setParent

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

• Parameters

  • type: string

  • hash: string

  • parentHash: string

  Returns Promise<ApiResponse<void>>

startChecklist

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

• Parameters

  • data: StartChecklistData

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

unarchive

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

• Parameters

  • type: string

  • hash: string

  Returns Promise<void>