@resolution/jira-api-client 0.7.8 → 0.10.0

package/lib/openapi/platform/services/TeamsInPlanService.d.ts

@@ -0,0 +1,294 @@
+import { CommonHttpService } from "../../core/CommonHttpService";
+import { type AddAtlassianTeamRequest, type CreatePlanOnlyTeamRequest, type GetAtlassianTeamResponse, type GetPlanOnlyTeamResponse, type PageWithCursorGetTeamResponseForPage } from "../models/teamsInPlan";
+/**
+ * This resource represents planning settings for plan-only and Atlassian teams in
+ * a plan. Use it to get, create, update and delete planning settings.
+ *
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan
+ * @category Services
+ */
+export declare class TeamsInPlanService extends CommonHttpService {
+    /**
+     * Adds an existing Atlassian team to a plan and configures their plannning
+     * settings.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path POST `/rest/api/3/plans/plan/{planId}/team/atlassian`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-post
+     * @param params
+     */
+    addAtlassianTeam: ({ planId, addAtlassianTeamRequest, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /**
+         * @example
+         * {
+         *   "capacity": 200,
+         *   "id": "AtlassianTeamId",
+         *   "issueSourceId": 0,
+         *   "planningStyle": "Scrum",
+         *   "sprintLength": 2
+         * }
+         */
+        addAtlassianTeamRequest: AddAtlassianTeamRequest;
+    }) => Promise<void>;
+    /**
+     * Creates a plan-only team and configures their planning settings.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path POST `/rest/api/3/plans/plan/{planId}/team/planonly`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-post
+     * @param params
+     */
+    createPlanOnlyTeam: ({ planId, createPlanOnlyTeamRequest, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /**
+         * @example
+         * {
+         *   "capacity": 200,
+         *   "issueSourceId": 0,
+         *   "memberAccountIds": [
+         *     "member1AccountId",
+         *     "member2AccountId"
+         *   ],
+         *   "name": "Team1",
+         *   "planningStyle": "Scrum",
+         *   "sprintLength": 2
+         * }
+         */
+        createPlanOnlyTeamRequest: CreatePlanOnlyTeamRequest;
+    }) => Promise<number>;
+    /**
+     * Deletes a plan-only team and their planning settings.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path DELETE `/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-planonlyteamid-delete
+     * @param params
+     */
+    deletePlanOnlyTeam: ({ planId, planOnlyTeamId, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The ID of the plan-only team. */
+        planOnlyTeamId: number;
+    }) => Promise<void>;
+    /**
+     * Returns planning settings for an Atlassian team in a plan.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "capacity": 220,
+     *   "id": "98WA-2JBO-12N3-2298",
+     *   "issueSourceId": 1,
+     *   "planningStyle": "Scrum",
+     *   "sprintLength": 2
+     * }
+     * ```
+     * @path GET `/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-atlassianteamid-get
+     * @param params
+     */
+    getAtlassianTeam: ({ planId, atlassianTeamId, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The ID of the Atlassian team. */
+        atlassianTeamId: string;
+    }) => Promise<GetAtlassianTeamResponse>;
+    /**
+     * Returns planning settings for a plan-only team.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "capacity": 30,
+     *   "id": 123,
+     *   "issueSourceId": 1,
+     *   "memberAccountIds": [
+     *     "mek2-3jno-01n3",
+     *     "kdsn-2nk3-2nn1"
+     *   ],
+     *   "name": "Team1",
+     *   "planningStyle": "Scrum",
+     *   "sprintLength": 2
+     * }
+     * ```
+     * @path GET `/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-planonlyteamid-get
+     * @param params
+     */
+    getPlanOnlyTeam: ({ planId, planOnlyTeamId, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The ID of the plan-only team. */
+        planOnlyTeamId: number;
+    }) => Promise<GetPlanOnlyTeamResponse>;
+    /**
+     * Returns a [paginated](#pagination) list of plan-only and Atlassian teams in a
+     * plan.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "cursor": "",
+     *   "isLast": true,
+     *   "maxResults": 2,
+     *   "nextPageCursor": "2",
+     *   "total": 10,
+     *   "values": [
+     *     {
+     *       "id": "1",
+     *       "name": "Team 1",
+     *       "type": "PlanOnly"
+     *     },
+     *     {
+     *       "id": "2",
+     *       "type": "Atlassian"
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/api/3/plans/plan/{planId}/team`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-get
+     * @param params
+     */
+    getTeams: ({ planId, cursor, maxResults, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The cursor to start from. If not provided, the first page will be returned. */
+        cursor?: string | undefined;
+        /**
+         * The maximum number of plan teams to return per page. The maximum value is 50.
+         * The default value is 50.
+         */
+        maxResults?: number | undefined;
+    }) => Promise<PageWithCursorGetTeamResponseForPage>;
+    /**
+     * Removes an Atlassian team from a plan and deletes their planning settings.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path DELETE `/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-atlassianteamid-delete
+     * @param params
+     */
+    removeAtlassianTeam: ({ planId, atlassianTeamId, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The ID of the Atlassian team. */
+        atlassianTeamId: string;
+    }) => Promise<void>;
+    /**
+     * Updates any of the following planning settings of an Atlassian team in a plan
+     * using [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902).
+     *
+     *  *  planningStyle
+     *  *  issueSourceId
+     *  *  sprintLength
+     *  *  capacity
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * *Note that "add" operations do not respect array indexes in target locations.
+     * Call the "Get Atlassian team in plan" endpoint to find out the order of array
+     * elements.*
+     *
+     * @returns Returned if the request is successful.
+     * @path PUT `/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-atlassianteamid-put
+     * @param params
+     */
+    updateAtlassianTeam: ({ planId, atlassianTeamId, requestBody, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The ID of the Atlassian team. */
+        atlassianTeamId: string;
+        /**
+         * @example
+         * ```
+         * [
+         *   {
+         *     "op": "replace",
+         *     "path": "/planningStyle",
+         *     "value": "Kanban"
+         *   }
+         * ]
+         * ```
+         */
+        requestBody: {
+            [key: string]: unknown;
+        };
+    }) => Promise<void>;
+    /**
+     * Updates any of the following planning settings of a plan-only team using [JSON
+     * Patch](https://datatracker.ietf.org/doc/html/rfc6902).
+     *
+     *  *  name
+     *  *  planningStyle
+     *  *  issueSourceId
+     *  *  sprintLength
+     *  *  capacity
+     *  *  memberAccountIds
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * *Note that "add" operations do not respect array indexes in target locations.
+     * Call the "Get plan-only team" endpoint to find out the order of array elements.*
+     *
+     * @returns Returned if the request is successful.
+     * @path PUT `/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}`
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-planonlyteamid-put
+     * @param params
+     */
+    updatePlanOnlyTeam: ({ planId, planOnlyTeamId, requestBody, }: {
+        /** The ID of the plan. */
+        planId: number;
+        /** The ID of the plan-only team. */
+        planOnlyTeamId: number;
+        /**
+         * @example
+         * ```
+         * [
+         *   {
+         *     "op": "replace",
+         *     "path": "/planningStyle",
+         *     "value": "Kanban"
+         *   }
+         * ]
+         * ```
+         */
+        requestBody: {
+            [key: string]: unknown;
+        };
+    }) => Promise<void>;
+    protected static initialize(): void;
+}