Function createSprint

createSprint(
    client: Client,
    parameters: {
        endDate?: string | Date;
        goal?: string;
        name: string;
        originBoardId?: number;
        startDate?: string | Date;
    },
    options?: RequestOptions,
): Promise<
    {
        completeDate?: Date;
        createdDate?: Date;
        endDate?: Date;
        goal?: string;
        id?: number;
        name?: string;
        originBoardId?: number;
        self?: string;
        startDate?: Date;
        state: "active"
        | "closed"
        | string & {}
        | "future";
        [key: string]: unknown;
    },
>
Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional.

Note that the sprint name is trimmed. Also, when starting sprints from the UI, the "endDate" set through this call is ignored and instead the last sprint's duration is used to fill the form.
Parameters
- client: Client
- parameters: {
      endDate?: string | Date;
      goal?: string;
      name: string;
      originBoardId?: number;
      startDate?: string | Date;
  }
- Optionaloptions: RequestOptions
Returns Promise<
    {
        completeDate?: Date;
        createdDate?: Date;
        endDate?: Date;
        goal?: string;
        id?: number;
        name?: string;
        originBoardId?: number;
        self?: string;
        startDate?: Date;
        state: "active"
        | "closed"
        | string & {}
        | "future";
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/sprint.ts:25

Function createSprint

Parameters

Returns Promise< { completeDate?: Date; createdDate?: Date; endDate?: Date; goal?: string; id?: number; name?: string; originBoardId?: number; self?: string; startDate?: Date; state: "active" | "closed" | string & {} | "future"; [key: string]: unknown; },>

Settings

Returns Promise<
{
completeDate?: Date;
createdDate?: Date;
endDate?: Date;
goal?: string;
id?: number;
name?: string;
originBoardId?: number;
self?: string;
startDate?: Date;
state: "active"
| "closed"
| string & {}
| "future";
[key: string]: unknown;
},
>