Type Alias: UpdateCard

type UpdateCard = object;

Defined in: parameters/updateCard.ts:94

Type Declaration

address?

optional address?: string;

For use with/by the Map View

closed?

optional closed?: boolean;

Whether the card should be archived (closed: true)

coordinates?

optional coordinates?: string;

For use with/by the Map View. Should be latitude,longitude

cover?

optional cover?: object;

Updates the card's cover | Option | Values | About | |--------|--------|-------| | color | pink, yellow, lime, blue, black, orange, red, purple, sky, green | Makes the cover a solid color . | | brightness

| dark, light | Determines whether the text on the cover should be dark or light. | url | An unsplash URL:

https://images.unsplash.com | Used if making an image the cover. Only Unsplash URLs work. | idAttachment | ID of an attachment on the card | Used if setting an attached image as the cover. | | size | normal, full | Determines whether to show the card name on the cover, or below it. |

brightness can be sent alongside any of the other parameters, but all of the other parameters are mutually exclusive; you can not have the cover be a color and an idAttachment at the same time.

On the brightness options, setting it to light will make the text on the card cover dark:

And vice versa, setting it to dark will make the text on the card cover light:

cover.value?

optional value?: object;

An object containing information regarding the card's cover brightness can be sent alongside any of the other parameters, but all of the other parameters are mutually exclusive; you can not have the cover be a color and an idAttachment at the same time.

cover.value.brightness?

optional brightness?: string & object | "light" | "dark";

Determines whether the text on the cover should be dark or light. Setting it to light will make the text on the card cover dark. And vice versa, setting it to dark will make the text on the card cover light

cover.value.color?

optional color?: 
  | string & object
  | "green"
  | "yellow"
  | "orange"
  | "red"
  | "purple"
  | "blue"
  | "sky"
  | "lime"
  | "pink"
  | "black";

One of: pink, yellow, lime, blue, black, orange, red, purple, sky, green

cover.value.url?

optional url?: string;

Used if making an image the cover. Only Unsplash URLs (https://images.unsplash.com/) work.

desc?

optional desc?: string;

The new description for the card

due?

optional due?: string | null;

When the card is due, or null

dueComplete?

optional dueComplete?: boolean;

Whether the status of the card is complete

id

id: string;

The ID of the Card

idAttachmentCover?

optional idAttachmentCover?: string;

The ID of the image attachment the card should use as its cover, or null for none

idBoard?

optional idBoard?: string;

The ID of the board the card should be on

idLabels?

optional idLabels?: string;

Comma-separated list of label IDs

idList?

optional idList?: string;

The ID of the list the card should be in

idMembers?

optional idMembers?: string;

Comma-separated list of member IDs

locationName?

optional locationName?: string;

For use with/by the Map View

name?

optional name?: string;

The new name for the card

pos?

optional pos?: number | "top" | "bottom" | string & object;

The position of the card in its list. top, bottom, or a positive float

start?

optional start?: string | null;

The start date of a card, or null

subscribed?

optional subscribed?: boolean;

Whether the member is should be subscribed to the card