LayerApiClient

Provides methods to call the layer API endpoints in the backend

Index

Properties

• add
• update

Properties

add

add: (attachTo: Pick<BimChange, id | apiUrl> & Partial<Pick<BimChange, name>>, data: BimChangeLayerData) => Promise<TypedResponse<BimChangeLayer>>

Type declaration

• • (attachTo: Pick<BimChange, id | apiUrl> & Partial<Pick<BimChange, name>>, data: BimChangeLayerData): Promise<TypedResponse<BimChangeLayer>>

  • Adds a layer

    ---

    Parameters

    • attachTo: Pick<BimChange, id | apiUrl> & Partial<Pick<BimChange, name>>

      a change to attach the layer to. id is required while name is optional. If name is not specified then it is calculated from data.format.

    • data: BimChangeLayerData

    Returns Promise<TypedResponse<BimChangeLayer>>

update

update: (layer: Pick<BimChangeLayer, metadata | id | apiUrl | name | etag>, options?: { data?: unknown; overwrite?: boolean }) => Promise<TypedResponse<BimChangeLayer>>

Type declaration

• • (layer: Pick<BimChangeLayer, metadata | id | apiUrl | name | etag>, options?: { data?: unknown; overwrite?: boolean }): Promise<TypedResponse<BimChangeLayer>>

  • Parameters

    • layer: Pick<BimChangeLayer, metadata | id | apiUrl | name | etag>

    • optionaloptions: { data?: unknown; overwrite?: boolean }

    Returns Promise<TypedResponse<BimChangeLayer>>