Class DocsService

constructor

• new DocsService(httpRequest): DocsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns DocsService

Readonly httpRequest

docCreate

• docCreate(options): CancelablePromise<{
      doc: DocPayload;
  }>

• Create a doc

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            content: string | Record<string, any>;
            title: string;
        };
    }

    • channelId: string

    • requestBody: {
          content: string | Record<string, any>;
          title: string;
      }

      • content: string | Record<string, any>

        The content of the doc

      • title: string

        The title of the doc

  Returns CancelablePromise<{
      doc: DocPayload;
  }>

  any Success

docDelete

• docDelete(options): CancelablePromise<void>

• Delete a doc

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docId: number;
    }

    • channelId: string

    • docId: number

  Returns CancelablePromise<void>

  void

docRead

• docRead(options): CancelablePromise<{
      doc: DocPayload;
  }>

• Get a doc

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docId: number;
    }

    • channelId: string

    • docId: number

  Returns CancelablePromise<{
      doc: DocPayload;
  }>

  any Success

docReadMany

• docReadMany(options): CancelablePromise<{
      docs: DocPayload[];
  }>

• Get docs Results returned will be ordered descending by the doc's updatedAt. before will filter based on the doc's updatedAt

  Throws

  ApiError

  Parameters

  • options: {
        before?: string;
        channelId: string;
        limit?: number;
    }

    • Optional before?: string

    • channelId: string

    • Optional limit?: number

  Returns CancelablePromise<{
      docs: DocPayload[];
  }>

  any Success

docUpdate

• docUpdate(options): CancelablePromise<{
      doc: DocPayload;
  }>

• Update a doc

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docId: number;
        requestBody: {
            content: string;
            title: string;
        };
    }

    • channelId: string

    • docId: number

    • requestBody: {
          content: string;
          title: string;
      }

      • content: string

        The content of the doc

      • title: string

        The title of the doc

  Returns CancelablePromise<{
      doc: DocPayload;
  }>

  any Success