feat: Teams and Users API: support more parameters (#482) (#523)

Author: Ribas160

src/core/index.ts

@@ -88,6 +88,8 @@ export interface PatchRequest {
 
 export type PatchOperation = 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
 
+export type ProjectRoles = 'manager' | 'developer' | 'translator' | 'proofreader' | 'language_coordinator' | 'member';
+
 export interface DownloadLink {
     url: string;
     expireIn: string;

src/teams/index.ts

@@ -5,6 +5,7 @@ import {
     PaginationOptions,
     PatchRequest,
     ProjectRole,
+    ProjectRoles,
     ResponseList,
     ResponseObject,
 } from '../core';
@@ -54,7 +55,7 @@ export class Teams extends CrowdinApi {
      * @param options optional pagination parameters for the request
      * @see https://support.crowdin.com/enterprise/api/#operation/api.teams.getMany
      */
-    listTeams(options?: PaginationOptions): Promise<ResponseList<TeamsModel.Team>>;
+    listTeams(options?: TeamsModel.ListTeamsOptions): Promise<ResponseList<TeamsModel.Team>>;
     /**
      * @param limit maximum number of items to retrieve (default 25)
      * @param offset starting offset in the collection (default 0)
@@ -63,14 +64,19 @@ export class Teams extends CrowdinApi {
      */
     listTeams(limit?: number, offset?: number): Promise<ResponseList<TeamsModel.Team>>;
     listTeams(
-        options?: number | ({ orderBy?: string } & PaginationOptions),
+        options?: number | ({ orderBy?: string } & TeamsModel.ListTeamsOptions),
         deprecatedOffset?: number,
     ): Promise<ResponseList<TeamsModel.Team>> {
         if (isOptionalNumber(options, '0' in arguments)) {
             options = { limit: options, offset: deprecatedOffset };
         }
         let url = `${this.url}/teams`;
         url = this.addQueryParam(url, 'orderBy', options.orderBy);
+        url = this.addQueryParam(url, 'search', options?.search);
+        url = this.addQueryParam(url, 'projectIds', options?.projectIds);
+        url = this.addQueryParam(url, 'projectRoles', options?.projectRoles?.toString());
+        url = this.addQueryParam(url, 'languageIds', options?.languageIds);
+        url = this.addQueryParam(url, 'groupIds', options?.groupIds);
         return this.getList(url, options.limit, options.offset);
     }
 
@@ -192,6 +198,15 @@ export namespace TeamsModel {
         permissions?: Permissions;
     }
 
+    export interface ListTeamsOptions extends PaginationOptions {
+        search?: string;
+        projectIds?: string;
+        projectRoles?: ProjectRoles[];
+        languageIds?: string;
+        groupIds?: string;
+        orderBy?: string;
+    }
+
     export interface ProjectTeamResources {
         skipped: ProjectTeamResource;
         added: ProjectTeamResource;

src/users/index.ts

@@ -5,6 +5,7 @@ import {
     PaginationOptions,
     PatchRequest,
     ProjectRole,
+    ProjectRoles,
     ResponseList,
     ResponseObject,
 } from '../core';
@@ -163,6 +164,14 @@ export class Users extends CrowdinApi {
         url = this.addQueryParam(url, 'search', options.search);
         url = this.addQueryParam(url, 'twoFactor', options.twoFactor);
         url = this.addQueryParam(url, 'orderBy', options.orderBy);
+        url = this.addQueryParam(url, 'organizationRoles', options?.organizationRoles?.toString());
+        url = this.addQueryParam(url, 'teamId', options?.teamId);
+        url = this.addQueryParam(url, 'projectIds', options?.projectIds);
+        url = this.addQueryParam(url, 'projectRoles', options?.projectRoles?.toString());
+        url = this.addQueryParam(url, 'languageIds', options?.languageIds);
+        url = this.addQueryParam(url, 'groupIds', options?.groupIds);
+        url = this.addQueryParam(url, 'lastSeenFrom', options?.lastSeenFrom);
+        url = this.addQueryParam(url, 'lastSeenTo', options?.lastSeenTo);
         return this.getList(url, options.limit, options.offset);
     }
 
@@ -274,6 +283,14 @@ export namespace UsersModel {
         search?: string;
         twoFactor?: TwoFactor;
         orderBy?: string;
+        organizationRoles?: OrganizationRoles[];
+        teamId?: number;
+        projectIds?: string;
+        projectRoles?: ProjectRoles[];
+        languageIds?: string;
+        groupIds?: string;
+        lastSeenFrom?: string;
+        lastSeenTo?: string;
     }
 
     export interface InviteUserRequest {
@@ -303,6 +320,8 @@ export namespace UsersModel {
 
     export type TwoFactor = 'enabled' | 'disabled';
 
+    export type OrganizationRoles = 'admin' | 'manager' | 'vendor' | 'client';
+
     export interface ProjectMember {
         id: number;
         username: string;