Class ListItemsService

constructor

• new ListItemsService(httpRequest): ListItemsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ListItemsService

Readonly httpRequest

listItemCompleteCreate

• listItemCompleteCreate(options): CancelablePromise<void>

• Complete a list item

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        listItemId: string;
    }

    • channelId: string

    • listItemId: string

  Returns CancelablePromise<void>

  void

listItemCompleteDelete

• listItemCompleteDelete(options): CancelablePromise<void>

• Uncomplete a list item

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        listItemId: string;
    }

    • channelId: string

    • listItemId: string

  Returns CancelablePromise<void>

  void

listItemCreate

• listItemCreate(options): CancelablePromise<{
      listItem: ListItemPayload;
  }>

• Create a list item

  Throws

  ApiError

  Parameters

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

    • channelId: string

    • requestBody: {
          message: string | Record<string, any>;
          note?: {
              content: string | Record<string, any>;
          };
      }

      • message: string | Record<string, any>

        The message of the list item

      • Optional note?: {
            content: string | Record<string, any>;
        }

        • content: string | Record<string, any>

          The note of the list item

  Returns CancelablePromise<{
      listItem: ListItemPayload;
  }>

  any Success

listItemDelete

• listItemDelete(options): CancelablePromise<void>

• Delete a list item

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        listItemId: string;
    }

    • channelId: string

    • listItemId: string

  Returns CancelablePromise<void>

  void

listItemRead

• listItemRead(options): CancelablePromise<{
      listItem: ListItemPayload;
  }>

• Get a list item

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        listItemId: string;
    }

    • channelId: string

    • listItemId: string

  Returns CancelablePromise<{
      listItem: ListItemPayload;
  }>

  any Success

listItemReadMany

• listItemReadMany(options): CancelablePromise<{
      listItems: ListItemSummaryPayload[];
  }>

• Get list items within a channel

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
    }

    • channelId: string

  Returns CancelablePromise<{
      listItems: ListItemSummaryPayload[];
  }>

  any Success

listItemUpdate

• listItemUpdate(options): CancelablePromise<{
      listItem: ListItemPayload;
  }>

• Update a list item

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        listItemId: string;
        requestBody: {
            message?: string;
            note?: null | {
                content: string;
            };
        };
    }

    • channelId: string

    • listItemId: string

    • requestBody: {
          message?: string;
          note?: null | {
              content: string;
          };
      }

      • Optional message?: string

        The message of the list item

      • Optional note?: null | {
            content: string;
        }

  Returns CancelablePromise<{
      listItem: ListItemPayload;
  }>

  any Success