Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentsApi

DocumentsApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

addDocuments

  • Add documents to a collection.

    summary

    Add Documents

    throws

    {RequiredError}

    memberof

    DocumentsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • body: AddDocumentsRequest

      JSON object

    • Optional options: any

    Returns Promise<AddDocumentsResponse>

deleteDocuments

patchDocuments

  • Update existing documents in a collection.

    summary

    Patch Documents

    throws

    {RequiredError}

    memberof

    DocumentsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • body: PatchDocumentsRequest

      JSON Patch objects

    • Optional options: any

    Returns Promise<PatchDocumentsResponse>

Generated using TypeDoc