@datadog/datadog-api-client 1.47.0 → 1.49.0

package/dist/packages/datadog-api-client-v2/apis/TeamsApi.d.ts

@@ -6,7 +6,15 @@ import { GetTeamMembershipsSort } from "../models/GetTeamMembershipsSort";
 import { ListTeamsInclude } from "../models/ListTeamsInclude";
 import { ListTeamsSort } from "../models/ListTeamsSort";
 import { Team } from "../models/Team";
+import { TeamConnection } from "../models/TeamConnection";
+import { TeamConnectionCreateRequest } from "../models/TeamConnectionCreateRequest";
+import { TeamConnectionDeleteRequest } from "../models/TeamConnectionDeleteRequest";
+import { TeamConnectionsResponse } from "../models/TeamConnectionsResponse";
 import { TeamCreateRequest } from "../models/TeamCreateRequest";
+import { TeamHierarchyLink } from "../models/TeamHierarchyLink";
+import { TeamHierarchyLinkCreateRequest } from "../models/TeamHierarchyLinkCreateRequest";
+import { TeamHierarchyLinkResponse } from "../models/TeamHierarchyLinkResponse";
+import { TeamHierarchyLinksResponse } from "../models/TeamHierarchyLinksResponse";
 import { TeamLinkCreateRequest } from "../models/TeamLinkCreateRequest";
 import { TeamLinkResponse } from "../models/TeamLinkResponse";
 import { TeamLinksResponse } from "../models/TeamLinksResponse";
@@ -16,7 +24,9 @@ import { TeamPermissionSettingUpdateRequest } from "../models/TeamPermissionSett
 import { TeamResponse } from "../models/TeamResponse";
 import { TeamsField } from "../models/TeamsField";
 import { TeamsResponse } from "../models/TeamsResponse";
+import { TeamSyncAttributesSource } from "../models/TeamSyncAttributesSource";
 import { TeamSyncRequest } from "../models/TeamSyncRequest";
+import { TeamSyncResponse } from "../models/TeamSyncResponse";
 import { TeamUpdateRequest } from "../models/TeamUpdateRequest";
 import { UserTeam } from "../models/UserTeam";
 import { UserTeamRequest } from "../models/UserTeamRequest";
@@ -25,21 +35,29 @@ import { UserTeamsResponse } from "../models/UserTeamsResponse";
 import { UserTeamUpdateRequest } from "../models/UserTeamUpdateRequest";
 export declare class TeamsApiRequestFactory extends BaseAPIRequestFactory {
     addMemberTeam(superTeamId: string, body: AddMemberTeamRequest, _options?: Configuration): Promise<RequestContext>;
+    addTeamHierarchyLink(body: TeamHierarchyLinkCreateRequest, _options?: Configuration): Promise<RequestContext>;
     createTeam(body: TeamCreateRequest, _options?: Configuration): Promise<RequestContext>;
+    createTeamConnections(body: TeamConnectionCreateRequest, _options?: Configuration): Promise<RequestContext>;
     createTeamLink(teamId: string, body: TeamLinkCreateRequest, _options?: Configuration): Promise<RequestContext>;
     createTeamMembership(teamId: string, body: UserTeamRequest, _options?: Configuration): Promise<RequestContext>;
     deleteTeam(teamId: string, _options?: Configuration): Promise<RequestContext>;
+    deleteTeamConnections(body: TeamConnectionDeleteRequest, _options?: Configuration): Promise<RequestContext>;
     deleteTeamLink(teamId: string, linkId: string, _options?: Configuration): Promise<RequestContext>;
     deleteTeamMembership(teamId: string, userId: string, _options?: Configuration): Promise<RequestContext>;
     getTeam(teamId: string, _options?: Configuration): Promise<RequestContext>;
+    getTeamHierarchyLink(linkId: string, _options?: Configuration): Promise<RequestContext>;
     getTeamLink(teamId: string, linkId: string, _options?: Configuration): Promise<RequestContext>;
     getTeamLinks(teamId: string, _options?: Configuration): Promise<RequestContext>;
     getTeamMemberships(teamId: string, pageSize?: number, pageNumber?: number, sort?: GetTeamMembershipsSort, filterKeyword?: string, _options?: Configuration): Promise<RequestContext>;
     getTeamPermissionSettings(teamId: string, _options?: Configuration): Promise<RequestContext>;
+    getTeamSync(filterSource: TeamSyncAttributesSource, _options?: Configuration): Promise<RequestContext>;
     getUserMemberships(userUuid: string, _options?: Configuration): Promise<RequestContext>;
     listMemberTeams(superTeamId: string, pageSize?: number, pageNumber?: number, fieldsTeam?: Array<TeamsField>, _options?: Configuration): Promise<RequestContext>;
+    listTeamConnections(pageSize?: number, pageNumber?: number, filterSources?: Array<string>, filterTeamIds?: Array<string>, filterConnectedTeamIds?: Array<string>, filterConnectionIds?: Array<string>, _options?: Configuration): Promise<RequestContext>;
+    listTeamHierarchyLinks(pageNumber?: number, pageSize?: number, filterParentTeam?: string, filterSubTeam?: string, _options?: Configuration): Promise<RequestContext>;
     listTeams(pageNumber?: number, pageSize?: number, sort?: ListTeamsSort, include?: Array<ListTeamsInclude>, filterKeyword?: string, filterMe?: boolean, fieldsTeam?: Array<TeamsField>, _options?: Configuration): Promise<RequestContext>;
     removeMemberTeam(superTeamId: string, memberTeamId: string, _options?: Configuration): Promise<RequestContext>;
+    removeTeamHierarchyLink(linkId: string, _options?: Configuration): Promise<RequestContext>;
     syncTeams(body: TeamSyncRequest, _options?: Configuration): Promise<RequestContext>;
     updateTeam(teamId: string, body: TeamUpdateRequest, _options?: Configuration): Promise<RequestContext>;
     updateTeamLink(teamId: string, linkId: string, body: TeamLinkCreateRequest, _options?: Configuration): Promise<RequestContext>;
@@ -55,6 +73,14 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     addMemberTeam(response: ResponseContext): Promise<void>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to addTeamHierarchyLink
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    addTeamHierarchyLink(response: ResponseContext): Promise<TeamHierarchyLinkResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -63,6 +89,14 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     createTeam(response: ResponseContext): Promise<TeamResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to createTeamConnections
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createTeamConnections(response: ResponseContext): Promise<TeamConnectionsResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -87,6 +121,14 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     deleteTeam(response: ResponseContext): Promise<void>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to deleteTeamConnections
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteTeamConnections(response: ResponseContext): Promise<void>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -111,6 +153,14 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getTeam(response: ResponseContext): Promise<TeamResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getTeamHierarchyLink
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getTeamHierarchyLink(response: ResponseContext): Promise<TeamHierarchyLinkResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -143,6 +193,14 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getTeamPermissionSettings(response: ResponseContext): Promise<TeamPermissionSettingsResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getTeamSync
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getTeamSync(response: ResponseContext): Promise<TeamSyncResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -159,6 +217,22 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     listMemberTeams(response: ResponseContext): Promise<TeamsResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to listTeamConnections
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listTeamConnections(response: ResponseContext): Promise<TeamConnectionsResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to listTeamHierarchyLinks
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listTeamHierarchyLinks(response: ResponseContext): Promise<TeamHierarchyLinksResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -175,6 +249,14 @@ export declare class TeamsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     removeMemberTeam(response: ResponseContext): Promise<void>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to removeTeamHierarchyLink
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    removeTeamHierarchyLink(response: ResponseContext): Promise<void>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -227,12 +309,24 @@ export interface TeamsApiAddMemberTeamRequest {
      */
     body: AddMemberTeamRequest;
 }
+export interface TeamsApiAddTeamHierarchyLinkRequest {
+    /**
+     * @type TeamHierarchyLinkCreateRequest
+     */
+    body: TeamHierarchyLinkCreateRequest;
+}
 export interface TeamsApiCreateTeamRequest {
     /**
      * @type TeamCreateRequest
      */
     body: TeamCreateRequest;
 }
+export interface TeamsApiCreateTeamConnectionsRequest {
+    /**
+     * @type TeamConnectionCreateRequest
+     */
+    body: TeamConnectionCreateRequest;
+}
 export interface TeamsApiCreateTeamLinkRequest {
     /**
      * None
@@ -262,6 +356,12 @@ export interface TeamsApiDeleteTeamRequest {
      */
     teamId: string;
 }
+export interface TeamsApiDeleteTeamConnectionsRequest {
+    /**
+     * @type TeamConnectionDeleteRequest
+     */
+    body: TeamConnectionDeleteRequest;
+}
 export interface TeamsApiDeleteTeamLinkRequest {
     /**
      * None
@@ -293,6 +393,13 @@ export interface TeamsApiGetTeamRequest {
      */
     teamId: string;
 }
+export interface TeamsApiGetTeamHierarchyLinkRequest {
+    /**
+     * The team hierarchy link's identifier
+     * @type string
+     */
+    linkId: string;
+}
 export interface TeamsApiGetTeamLinkRequest {
     /**
      * None
@@ -346,6 +453,13 @@ export interface TeamsApiGetTeamPermissionSettingsRequest {
      */
     teamId: string;
 }
+export interface TeamsApiGetTeamSyncRequest {
+    /**
+     * Filter by the external source platform for team synchronization
+     * @type TeamSyncAttributesSource
+     */
+    filterSource: TeamSyncAttributesSource;
+}
 export interface TeamsApiGetUserMembershipsRequest {
     /**
      * None
@@ -375,6 +489,60 @@ export interface TeamsApiListMemberTeamsRequest {
      */
     fieldsTeam?: Array<TeamsField>;
 }
+export interface TeamsApiListTeamConnectionsRequest {
+    /**
+     * Size for a given page. The maximum allowed value is 100.
+     * @type number
+     */
+    pageSize?: number;
+    /**
+     * Specific page number to return.
+     * @type number
+     */
+    pageNumber?: number;
+    /**
+     * Filter team connections by external source systems.
+     * @type Array<string>
+     */
+    filterSources?: Array<string>;
+    /**
+     * Filter team connections by Datadog team IDs.
+     * @type Array<string>
+     */
+    filterTeamIds?: Array<string>;
+    /**
+     * Filter team connections by connected team IDs from external systems.
+     * @type Array<string>
+     */
+    filterConnectedTeamIds?: Array<string>;
+    /**
+     * Filter team connections by connection IDs.
+     * @type Array<string>
+     */
+    filterConnectionIds?: Array<string>;
+}
+export interface TeamsApiListTeamHierarchyLinksRequest {
+    /**
+     * Specific page number to return.
+     * @type number
+     */
+    pageNumber?: number;
+    /**
+     * Size for a given page. The maximum allowed value is 100.
+     * @type number
+     */
+    pageSize?: number;
+    /**
+     * Filter by parent team ID
+     * @type string
+     */
+    filterParentTeam?: string;
+    /**
+     * Filter by sub team ID
+     * @type string
+     */
+    filterSubTeam?: string;
+}
 export interface TeamsApiListTeamsRequest {
     /**
      * Specific page number to return.
@@ -424,6 +592,13 @@ export interface TeamsApiRemoveMemberTeamRequest {
      */
     memberTeamId: string;
 }
+export interface TeamsApiRemoveTeamHierarchyLinkRequest {
+    /**
+     * The team hierarchy link's identifier
+     * @type string
+     */
+    linkId: string;
+}
 export interface TeamsApiSyncTeamsRequest {
     /**
      * @type TeamSyncRequest
@@ -497,15 +672,27 @@ export declare class TeamsApi {
     /**
      * Add a member team.
      * Adds the team given by the `id` in the body as a member team of the super team.
+     *
+     * **Note**: This API is deprecated. For creating team hierarchy links, use the team hierarchy links API: `POST /api/v2/team-hierarchy-links`.
      * @param param The request object
      */
     addMemberTeam(param: TeamsApiAddMemberTeamRequest, options?: Configuration): Promise<void>;
+    /**
+     * Create a new team hierarchy link between a parent team and a sub team.
+     * @param param The request object
+     */
+    addTeamHierarchyLink(param: TeamsApiAddTeamHierarchyLinkRequest, options?: Configuration): Promise<TeamHierarchyLinkResponse>;
     /**
      * Create a new team.
      * User IDs passed through the `users` relationship field are added to the team.
      * @param param The request object
      */
     createTeam(param: TeamsApiCreateTeamRequest, options?: Configuration): Promise<TeamResponse>;
+    /**
+     * Create multiple team connections.
+     * @param param The request object
+     */
+    createTeamConnections(param: TeamsApiCreateTeamConnectionsRequest, options?: Configuration): Promise<TeamConnectionsResponse>;
     /**
      * Add a new link to a team.
      * @param param The request object
@@ -513,6 +700,8 @@ export declare class TeamsApi {
     createTeamLink(param: TeamsApiCreateTeamLinkRequest, options?: Configuration): Promise<TeamLinkResponse>;
     /**
      * Add a user to a team.
+     *
+     * **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).
      * @param param The request object
      */
     createTeamMembership(param: TeamsApiCreateTeamMembershipRequest, options?: Configuration): Promise<UserTeamResponse>;
@@ -521,6 +710,11 @@ export declare class TeamsApi {
      * @param param The request object
      */
     deleteTeam(param: TeamsApiDeleteTeamRequest, options?: Configuration): Promise<void>;
+    /**
+     * Delete multiple team connections.
+     * @param param The request object
+     */
+    deleteTeamConnections(param: TeamsApiDeleteTeamConnectionsRequest, options?: Configuration): Promise<void>;
     /**
      * Remove a link from a team.
      * @param param The request object
@@ -528,6 +722,8 @@ export declare class TeamsApi {
     deleteTeamLink(param: TeamsApiDeleteTeamLinkRequest, options?: Configuration): Promise<void>;
     /**
      * Remove a user from a team.
+     *
+     * **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).
      * @param param The request object
      */
     deleteTeamMembership(param: TeamsApiDeleteTeamMembershipRequest, options?: Configuration): Promise<void>;
@@ -536,6 +732,11 @@ export declare class TeamsApi {
      * @param param The request object
      */
     getTeam(param: TeamsApiGetTeamRequest, options?: Configuration): Promise<TeamResponse>;
+    /**
+     * Get a single team hierarchy link for the given link_id.
+     * @param param The request object
+     */
+    getTeamHierarchyLink(param: TeamsApiGetTeamHierarchyLinkRequest, options?: Configuration): Promise<TeamHierarchyLinkResponse>;
     /**
      * Get a single link for a team.
      * @param param The request object
@@ -560,6 +761,12 @@ export declare class TeamsApi {
      * @param param The request object
      */
     getTeamPermissionSettings(param: TeamsApiGetTeamPermissionSettingsRequest, options?: Configuration): Promise<TeamPermissionSettingsResponse>;
+    /**
+     * Get all team synchronization configurations.
+     * Returns a list of configurations used for linking or provisioning teams with external sources like GitHub.
+     * @param param The request object
+     */
+    getTeamSync(param: TeamsApiGetTeamSyncRequest, options?: Configuration): Promise<TeamSyncResponse>;
     /**
      * Get a list of memberships for a user
      * @param param The request object
@@ -567,6 +774,9 @@ export declare class TeamsApi {
     getUserMemberships(param: TeamsApiGetUserMembershipsRequest, options?: Configuration): Promise<UserTeamsResponse>;
     /**
      * Get all member teams.
+     *
+     * **Note**: This API is deprecated. For team hierarchy relationships (parent-child
+     * teams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`.
      * @param param The request object
      */
     listMemberTeams(param: TeamsApiListMemberTeamsRequest, options?: Configuration): Promise<TeamsResponse>;
@@ -574,6 +784,24 @@ export declare class TeamsApi {
      * Provide a paginated version of listMemberTeams returning a generator with all the items.
      */
     listMemberTeamsWithPagination(param: TeamsApiListMemberTeamsRequest, options?: Configuration): AsyncGenerator<Team>;
+    /**
+     * Returns all team connections.
+     * @param param The request object
+     */
+    listTeamConnections(param?: TeamsApiListTeamConnectionsRequest, options?: Configuration): Promise<TeamConnectionsResponse>;
+    /**
+     * Provide a paginated version of listTeamConnections returning a generator with all the items.
+     */
+    listTeamConnectionsWithPagination(param?: TeamsApiListTeamConnectionsRequest, options?: Configuration): AsyncGenerator<TeamConnection>;
+    /**
+     * List all team hierarchy links that match the provided filters.
+     * @param param The request object
+     */
+    listTeamHierarchyLinks(param?: TeamsApiListTeamHierarchyLinksRequest, options?: Configuration): Promise<TeamHierarchyLinksResponse>;
+    /**
+     * Provide a paginated version of listTeamHierarchyLinks returning a generator with all the items.
+     */
+    listTeamHierarchyLinksWithPagination(param?: TeamsApiListTeamHierarchyLinksRequest, options?: Configuration): AsyncGenerator<TeamHierarchyLink>;
     /**
      * Get all teams.
      * Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters.
@@ -586,9 +814,16 @@ export declare class TeamsApi {
     listTeamsWithPagination(param?: TeamsApiListTeamsRequest, options?: Configuration): AsyncGenerator<Team>;
     /**
      * Remove a super team's member team identified by `member_team_id`.
+     *
+     * **Note**: This API is deprecated. For deleting team hierarchy links, use the team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`.
      * @param param The request object
      */
     removeMemberTeam(param: TeamsApiRemoveMemberTeamRequest, options?: Configuration): Promise<void>;
+    /**
+     * Remove a team hierarchy link by the given link_id.
+     * @param param The request object
+     */
+    removeTeamHierarchyLink(param: TeamsApiRemoveTeamHierarchyLinkRequest, options?: Configuration): Promise<void>;
     /**
      * This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names.
      * It evaluates all current Datadog teams and compares them against teams in the GitHub organization
@@ -600,7 +835,7 @@ export declare class TeamsApi {
      * [A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/),
      * and the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug
      * using a normalized exact match; case is ignored and spaces are removed. No modifications are made
-     * to teams in GitHub. This will not create new Teams in Datadog.
+     * to teams in GitHub. This only creates new teams in Datadog when type is set to `provision`.
      * @param param The request object
      */
     syncTeams(param: TeamsApiSyncTeamsRequest, options?: Configuration): Promise<void>;
@@ -617,6 +852,8 @@ export declare class TeamsApi {
     updateTeamLink(param: TeamsApiUpdateTeamLinkRequest, options?: Configuration): Promise<TeamLinkResponse>;
     /**
      * Update a user's membership attributes on a team.
+     *
+     * **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).
      * @param param The request object
      */
     updateTeamMembership(param: TeamsApiUpdateTeamMembershipRequest, options?: Configuration): Promise<UserTeamResponse>;