/*! * Copyright Adaptavist 2022 (c) All rights reserved */ import { AllocationBeanAsResponse } from "../definitions/AllocationBeanAsResponse"; import { ErrorStrategyOption } from "../errorStrategy"; import { HeadersOption } from "@managed-api/commons-core"; import { KeyTypePairBean } from "../definitions/KeyTypePairBean"; import { PlanApprovalBean } from "../definitions/PlanApprovalBean"; import { PlanItemBean } from "../definitions/PlanItemBean"; import { RecurrenceInputBean } from "../definitions/RecurrenceInputBean"; import { IdTypePairBean } from "../definitions/IdTypePairBean"; export interface GetAllocationsRequest extends HeadersOption, ErrorStrategyOption { /** * Example: assigneeKeys=johnDoe&assigneeKeys=joeSchmoe, can be either usernames or team ids, according to assigneeType */ assigneeKeys?: Array; /** * Type of assignee. */ assigneeType?: "USER" | "TEAM"; /** * ID of the item which the plan is for. */ planItemId?: number; /** * Type of the item which the plan is for. */ planItemType?: string; /** * Start of search period. If this is defined but no endDate is defined, it will query plans one month ahead from now. **INCLUSIVE** */ startDate?: string; /** * End of search period. If this is defined but no startDate is defined, it will query plans one month back from now. **INCLUSIVE** */ endDate?: string; /** * If true then all user plans that are reflected from a team plan are also included. */ expandReflections?: boolean; } declare type GetAllocationsResponseOKType = Array; export interface GetAllocationsResponseOK extends GetAllocationsResponseOKType { } export declare type GetAllocationsResponseError = undefined; export interface CreateAllocationRequest extends HeadersOption, ErrorStrategyOption { body: { assignee: KeyTypePairBean; commitment?: number; description?: string; /** * End date is **Inclusive** */ end: string; /** * Include Weekends and Holidays? */ includeNonWorkingDays?: boolean; planApproval?: PlanApprovalBean; planItem: PlanItemBean; recurrence?: RecurrenceInputBean; scope: IdTypePairBean; secondsPerDay: number; /** * Start date is **Inclusive** */ start: string; }; } declare type CreateAllocationResponseOKType = AllocationBeanAsResponse; export interface CreateAllocationResponseOK extends CreateAllocationResponseOKType { } export declare type CreateAllocationResponseError = undefined; export interface DeleteAllocationRequest extends HeadersOption, ErrorStrategyOption { /** * ID of the Plan. */ allocationId: number; } export declare type DeleteAllocationResponseOK = undefined; export declare type DeleteAllocationResponseError = undefined; export interface GetAllocationRequest extends HeadersOption, ErrorStrategyOption { /** * ID of the plan. */ allocationId: number; /** * If set to 'children', then all reflected and recurring plans for the specified plan are also fetched. */ expand?: string; /** * Start date of the period of desired recurring plans. Only needed if expand is set. **INCLUSIVE** */ startDate?: string; /** * End Date of the period of desired recurring plans. Only needed if expand is set. **INCLUSIVE** */ endDate?: string; } declare type GetAllocationResponseOKType = AllocationBeanAsResponse; export interface GetAllocationResponseOK extends GetAllocationResponseOKType { } export declare type GetAllocationResponseError = undefined; export interface UpdateAllocationRequest extends HeadersOption, ErrorStrategyOption { /** * ID of Plan. */ allocationId: number; body: { assignee: KeyTypePairBean; commitment?: number; description?: string; /** * End date is **Inclusive** */ end: string; /** * Include Weekends and Holidays? */ includeNonWorkingDays?: boolean; planApproval?: PlanApprovalBean; planItem: PlanItemBean; recurrence?: RecurrenceInputBean; scope: IdTypePairBean; secondsPerDay: number; /** * Start date is **Inclusive** */ start: string; }; } declare type UpdateAllocationResponseOKType = AllocationBeanAsResponse; export interface UpdateAllocationResponseOK extends UpdateAllocationResponseOKType { } export declare type UpdateAllocationResponseError = undefined; export {}; //# sourceMappingURL=allocation.d.ts.map