jdalrymple/gitbeaker

View on GitHub
packages/core/src/resources/GroupActivityAnalytics.ts

Summary

Maintainability
A
0 mins
Test Coverage
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper } from '../infrastructure';
import type { GitlabAPIResponse, ShowExpanded, Sudo } from '../infrastructure';

export interface GroupAnalyticsIssuesCountSchema extends Record<string, unknown> {
  issues_count: number;
}

export interface GroupAnalyticsMRsCountSchema extends Record<string, unknown> {
  merge_requests_count: number;
}

export interface GroupAnalyticsNewMembersCountSchema extends Record<string, unknown> {
  new_members_count: number;
}

export class GroupActivityAnalytics<C extends boolean = false> extends BaseResource<C> {
  showIssuesCount<E extends boolean = false>(
    groupPath: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<GroupAnalyticsIssuesCountSchema, C, E, void>> {
    return RequestHelper.get<GroupAnalyticsIssuesCountSchema>()(
      this,
      'analytics/group_activity/issues_count',
      {
        searchParams: {
          groupPath,
        },
        ...options,
      },
    );
  }

  showMergeRequestsCount<E extends boolean = false>(
    groupPath: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<GroupAnalyticsMRsCountSchema, C, E, void>> {
    return RequestHelper.get<GroupAnalyticsMRsCountSchema>()(
      this,
      'analytics/group_activity/merge_requests_count',
      {
        searchParams: {
          groupPath,
        },
        ...options,
      },
    );
  }

  showNewMembersCount<E extends boolean = false>(
    groupPath: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<GroupAnalyticsNewMembersCountSchema, C, E, void>> {
    return RequestHelper.get<GroupAnalyticsNewMembersCountSchema>()(
      this,
      'analytics/group_activity/new_members_count',
      {
        searchParams: {
          groupPath,
        },
        ...options,
      },
    );
  }
}