Class CategoriesService

constructor

• new CategoriesService(httpRequest): CategoriesService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns CategoriesService

Readonly httpRequest

categoryCreate

• categoryCreate(options): CancelablePromise<{
      category: CategoryPayload;
  }>

• Create a category

  Throws

  ApiError

  Parameters

  • options: {
        requestBody: {
            groupId?: string;
            name: string;
        };
        serverId: string;
    }

    • requestBody: {
          groupId?: string;
          name: string;
      }

      • Optional groupId?: string

        The ID of the group. If not provided, the category will be created in the "Server home" group from serverId.

      • name: string

        Name of the category

    • serverId: string

  Returns CancelablePromise<{
      category: CategoryPayload;
  }>

  any Success

categoryDelete

• categoryDelete(options): CancelablePromise<{
      category: CategoryPayload;
  }>

• Delete a category

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        serverId: string;
    }

    • categoryId: number

    • serverId: string

  Returns CancelablePromise<{
      category: CategoryPayload;
  }>

  any Success

categoryRead

• categoryRead(options): CancelablePromise<{
      category: CategoryPayload;
  }>

• Read a category

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        serverId: string;
    }

    • categoryId: number

    • serverId: string

  Returns CancelablePromise<{
      category: CategoryPayload;
  }>

  any Success

categoryUpdate

• categoryUpdate(options): CancelablePromise<{
      category: CategoryPayload;
  }>

• Update a category

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        requestBody: {
            name: string;
        };
        serverId: string;
    }

    • categoryId: number

    • requestBody: {
          name: string;
      }

      • name: string

        Name of the category

    • serverId: string

  Returns CancelablePromise<{
      category: CategoryPayload;
  }>

  any Success