Type Alias: GetNotification

type GetNotification = object;

Defined in: parameters/getNotification.ts:347

Type Declaration

board?

optional board?: boolean;

Whether to include the board object

boardFields?

optional boardFields?: 
  | "name"
  | "id"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "prefs"
  | "limits"
  | "idMemberCreator"
  | "memberships"
  | "descData"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "enterpriseOwned"
  | (
  | "name"
  | "id"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "prefs"
  | "limits"
  | "idMemberCreator"
  | "memberships"
  | "descData"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "enterpriseOwned")[];

all or a comma-separated list of board fields

card?

optional card?: boolean;

Whether to include the card object

cardFields?

optional cardFields?: 
  | "name"
  | "id"
  | "address"
  | "url"
  | "closed"
  | "desc"
  | "labels"
  | string & object
  | "idShort"
  | "shortLink"
  | "idList"
  | "idLabels"
  | "pos"
  | "due"
  | "dueComplete"
  | "limits"
  | "creationMethod"
  | "isTemplate"
  | "dateLastActivity"
  | "descData"
  | "shortUrl"
  | "subscribed"
  | "dueReminder"
  | "idBoard"
  | "badges"
  | "checkItemStates"
  | "coordinates"
  | "idChecklists"
  | "idMembers"
  | "idMembersVoted"
  | "idAttachmentCover"
  | "locationName"
  | "manualCoverAttachment"
  | "cover"
  | (
  | "name"
  | "id"
  | "address"
  | "url"
  | "closed"
  | "desc"
  | "labels"
  | string & object
  | "idShort"
  | "shortLink"
  | "idList"
  | "idLabels"
  | "pos"
  | "due"
  | "dueComplete"
  | "limits"
  | "creationMethod"
  | "isTemplate"
  | "dateLastActivity"
  | "descData"
  | "shortUrl"
  | "subscribed"
  | "dueReminder"
  | "idBoard"
  | "badges"
  | "checkItemStates"
  | "coordinates"
  | "idChecklists"
  | "idMembers"
  | "idMembersVoted"
  | "idAttachmentCover"
  | "locationName"
  | "manualCoverAttachment"
  | "cover")[];

all or a comma-separated list of card fields

display?

optional display?: boolean;

Whether to include the display object with the results

entities?

optional entities?: boolean;

Whether to include the entities object with the results

fields?

optional fields?: 
  | "type"
  | "data"
  | "id"
  | string & object
  | "date"
  | "reactions"
  | "idMemberCreator"
  | "card"
  | "board"
  | "idAction"
  | "unread"
  | "dateRead"
  | (
  | "type"
  | "data"
  | "id"
  | string & object
  | "date"
  | "reactions"
  | "idMemberCreator"
  | "card"
  | "board"
  | "idAction"
  | "unread"
  | "dateRead")[];

all or a comma-separated list of notification fields

id

id: string;

The ID of the notification

list?

optional list?: boolean;

Whether to include the list object

member?

optional member?: boolean;

Whether to include the member object

memberCreator?

optional memberCreator?: boolean;

Whether to include the member object of the creator

memberCreatorFields?

optional memberCreatorFields?: 
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations"
  | (
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations")[];

all or a comma-separated list of member fields

memberFields?

optional memberFields?: 
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations"
  | (
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations")[];

all or a comma-separated list of member fields

organization?

optional organization?: boolean;

Whether to include the organization object

organizationFields?

optional organizationFields?: 
  | "name"
  | "id"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited"
  | (
  | "name"
  | "id"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited")[];

all or a comma-separated list of organization fields