/*! * Copyright Adaptavist 2022 (c) All rights reserved */ import { TrelloID } from "../definitions/TrelloID"; import { MemberFields } from "../definitions/MemberFields"; import { MembershipsAsResponse } from "../definitions/MembershipsAsResponse"; import { ErrorStrategyOption } from "../errorStrategy"; import { HeadersOption } from "@managed-api/commons-core"; import { BoardAsResponse } from "../definitions/BoardAsResponse"; import { ErrorAsResponse } from "../definitions/ErrorAsResponse"; import { Label } from "../definitions/Label"; import { LabelAsResponse } from "../definitions/LabelAsResponse"; import { ViewFilter } from "../definitions/ViewFilter"; import { TrelloListAsResponse } from "../definitions/TrelloListAsResponse"; export interface GetMembershipsForBoardRequest extends HeadersOption, ErrorStrategyOption { /** * The ID of the board */ id: TrelloID; /** * One of `admins`, `all`, `none`, `normal` */ filter?: "admins" | "all" | "none" | "normal"; /** * Works for premium organizations only. */ activity?: boolean; /** * Shows the type of member to the org the user is. For instance, an org admin will have a `orgMemberType` of `admin`. */ orgMemberType?: boolean; /** * Determines whether to include a [nested member object](/cloud/trello/guides/rest-api/nested-resources/). */ member?: boolean; /** * Fields to show if `member=true`. Valid values: [nested member resource fields](/cloud/trello/guides/rest-api/nested-resources/). */ member_fields?: MemberFields; } declare type GetMembershipsForBoardResponseOKType = MembershipsAsResponse; export interface GetMembershipsForBoardResponseOK extends GetMembershipsForBoardResponseOKType { } export declare type GetMembershipsForBoardResponseError = undefined; export interface GetBoardRequest extends HeadersOption, ErrorStrategyOption { id: TrelloID; /** * This is a nested resource. Read more about actions as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ actions?: string; /** * Valid values are one of: `mine` or `none`. */ boardStars?: string; /** * This is a nested resource. Read more about cards as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ cards?: string; /** * Use with the `cards` param to include card pluginData with the response */ card_pluginData?: boolean; /** * This is a nested resource. Read more about checklists as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ checklists?: string; /** * This is a nested resource. Read more about custom fields as nested resources [here](#custom-fields-nested-resource). */ customFields?: boolean; /** * The fields of the board to be included in the response. Valid values: all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idMemberCreator, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url */ fields?: string; /** * This is a nested resource. Read more about labels as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ labels?: string; /** * This is a nested resource. Read more about lists as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ lists?: string; /** * This is a nested resource. Read more about members as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ members?: string; /** * This is a nested resource. Read more about memberships as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ memberships?: string; /** * Determines whether the pluginData for this board should be returned. Valid values: true or false. */ pluginData?: boolean; /** * This is a nested resource. Read more about organizations as nested resources [here](/cloud/trello/guides/rest-api/nested-resources/). */ organization?: boolean; /** * Use with the `organization` param to include organization pluginData with the response */ organization_pluginData?: boolean; myPrefs?: boolean; /** * Also known as collections, tags, refer to the collection(s) that a Board belongs to. */ tags?: boolean; } declare type GetBoardResponseOKType = BoardAsResponse; export interface GetBoardResponseOK extends GetBoardResponseOKType { } declare type GetBoardResponseErrorType = ErrorAsResponse & ErrorAsResponse & ErrorAsResponse; export interface GetBoardResponseError extends GetBoardResponseErrorType { } export interface UpdateBoardRequest extends HeadersOption, ErrorStrategyOption { id: TrelloID; /** * The new name for the board. 1 to 16384 characters long. */ name?: string; /** * A new description for the board, 0 to 16384 characters long */ desc?: string; /** * Whether the board is closed */ closed?: boolean; /** * Whether the acting user is subscribed to the board */ subscribed?: TrelloID; /** * The id of the Workspace the board should be moved to */ idOrganization?: string; /** * One of: org, private, public */ "prefs/permissionLevel"?: string; /** * Whether Workspace members can join the board themselves */ "prefs/selfJoin"?: boolean; /** * Whether card covers should be displayed on this board */ "prefs/cardCovers"?: boolean; /** * Determines whether the Voting Power-Up should hide who voted on cards or not. */ "prefs/hideVotes"?: boolean; /** * Who can invite people to this board. One of: admins, members */ "prefs/invitations"?: string; /** * Who can vote on this board. One of disabled, members, observers, org, public */ "prefs/voting"?: string; /** * Who can comment on cards on this board. One of: disabled, members, observers, org, public */ "prefs/comments"?: string; /** * The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey */ "prefs/background"?: string; /** * One of: pirate, regular */ "prefs/cardAging"?: string; /** * Determines whether the calendar feed is enabled or not. */ "prefs/calendarFeedEnabled"?: boolean; /** * Name for the green label. 1 to 16384 characters long */ "labelNames/green"?: string; /** * Name for the yellow label. 1 to 16384 characters long */ "labelNames/yellow"?: string; /** * Name for the orange label. 1 to 16384 characters long */ "labelNames/orange"?: string; /** * Name for the red label. 1 to 16384 characters long */ "labelNames/red"?: string; /** * Name for the purple label. 1 to 16384 characters long */ "labelNames/purple"?: string; /** * Name for the blue label. 1 to 16384 characters long */ "labelNames/blue"?: string; } declare type UpdateBoardResponseOKType = BoardAsResponse; export interface UpdateBoardResponseOK extends UpdateBoardResponseOKType { } export declare type UpdateBoardResponseError = undefined; export interface DeleteBoardRequest extends HeadersOption, ErrorStrategyOption { id: TrelloID; } declare type DeleteBoardResponseOKType = { _value?: any; }; export interface DeleteBoardResponseOK extends DeleteBoardResponseOKType { } export declare type DeleteBoardResponseError = undefined; export interface CreateBoardRequest extends HeadersOption, ErrorStrategyOption { /** * The new name for the board. 1 to 16384 characters long. */ name: string; /** * Determines whether to use the default set of labels. */ defaultLabels?: boolean; /** * Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if `idBoardSource` is provided. */ defaultLists?: boolean; /** * A new description for the board, 0 to 16384 characters long */ desc?: string; /** * The id or name of the Workspace the board should belong to. */ idOrganization?: TrelloID; /** * The id of a board to copy into the new board. */ idBoardSource?: TrelloID; /** * To keep cards from the original board pass in the value `cards` */ keepFromSource?: "cards" | "none"; /** * The Power-Ups that should be enabled on the new board. One of: `all`, `calendar`, `cardAging`, `recap`, `voting`. */ powerUps?: "all" | "calendar" | "cardAging" | "recap" | "voting"; /** * The permissions level of the board. One of: `org`, `private`, `public`. */ prefs_permissionLevel?: "org" | "private" | "public"; /** * Who can vote on this board. One of `disabled`, `members`, `observers`, `org`, `public`. */ prefs_voting?: "disabled" | "members" | "observers" | "org" | "public"; /** * Who can comment on cards on this board. One of: `disabled`, `members`, `observers`, `org`, `public`. */ prefs_comments?: "disabled" | "members" | "observers" | "org" | "public"; /** * Determines what types of members can invite users to join. One of: `admins`, `members`. */ prefs_invitations?: "members" | "admins"; /** * Determines whether users can join the boards themselves or whether they have to be invited. */ prefs_selfJoin?: boolean; /** * Determines whether card covers are enabled. */ prefs_cardCovers?: boolean; /** * The id of a custom background or one of: `blue`, `orange`, `green`, `red`, `purple`, `pink`, `lime`, `sky`, `grey`. */ prefs_background?: "blue" | "orange" | "green" | "red" | "purple" | "pink" | "lime" | "sky" | "grey"; /** * Determines the type of card aging that should take place on the board if card aging is enabled. One of: `pirate`, `regular`. */ prefs_cardAging?: "pirate" | "regular"; } declare type CreateBoardResponseOKType = BoardAsResponse; export interface CreateBoardResponseOK extends CreateBoardResponseOKType { } export declare type CreateBoardResponseError = undefined; export interface GetLabelsForBoardRequest extends HeadersOption, ErrorStrategyOption { /** * The ID of the Board. */ id: TrelloID; /** * The fields to be returned for the Labels. */ fields?: Label; /** * The number of Labels to be returned. */ limit?: number; } declare type GetLabelsForBoardResponseOKType = Array; export interface GetLabelsForBoardResponseOK extends GetLabelsForBoardResponseOKType { } export declare type GetLabelsForBoardResponseError = undefined; export interface GetListsForBoardRequest extends HeadersOption, ErrorStrategyOption { /** * The ID of the board */ id: TrelloID; /** * Filter to apply to Cards. */ cards?: ViewFilter; /** * `all` or a comma-separated list of card [fields](/cloud/trello/guides/rest-api/object-definitions/#card-object) */ card_fields?: string; /** * Filter to apply to Lists */ filter?: ViewFilter; /** * `all` or a comma-separated list of list [fields](/cloud/trello/guides/rest-api/object-definitions/) */ fields?: string; } declare type GetListsForBoardResponseOKType = Array; export interface GetListsForBoardResponseOK extends GetListsForBoardResponseOKType { } export declare type GetListsForBoardResponseError = undefined; export {}; //# sourceMappingURL=board.d.ts.map