Function: updateComponent()

function updateComponent(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  archived?: boolean;
  assigneeType?:   | string & object
     | "PROJECT_DEFAULT"
     | "COMPONENT_LEAD"
     | "PROJECT_LEAD"
     | "UNASSIGNED";
  deleted?: boolean;
  description?: string;
  id?: string;
  lead?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  leadUserName?: string;
  name?: string;
  project?: string;
  self?: string;
}>;

Defined in: src/server/api/projectComponents.ts:82

Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body?: { archived?: boolean; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; deleted?: boolean; description?: string; id?: string; lead?: { active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; leadUserName?: string; name?: string; project?: string; self?: string; }; id: string; }	-
parameters.body?	{ archived?: boolean; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; deleted?: boolean; description?: string; id?: string; lead?: { active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; leadUserName?: string; name?: string; project?: string; self?: string; }	-
parameters.body.archived?	boolean	-
parameters.body.assigneeType?	| string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"	-
parameters.body.deleted?	boolean	-
parameters.body.description?	string	-
parameters.body.id?	string	-
parameters.body.lead?	{ active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.body.lead.active?	boolean	-
parameters.body.lead.applicationRoles?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.lead.applicationRoles.callback?	Record<string, never>	-
parameters.body.lead.applicationRoles.maxResults?	number	-
parameters.body.lead.applicationRoles.pagingCallback?	Record<string, never>	-
parameters.body.lead.applicationRoles.size?	number	-
parameters.body.lead.avatarUrls?	Record<string, string>	-
parameters.body.lead.deleted?	boolean	-
parameters.body.lead.displayName?	string	-
parameters.body.lead.emailAddress?	string	-
parameters.body.lead.expand?	string	-
parameters.body.lead.groups?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.lead.groups.callback?	Record<string, never>	-
parameters.body.lead.groups.maxResults?	number	-
parameters.body.lead.groups.pagingCallback?	Record<string, never>	-
parameters.body.lead.groups.size?	number	-
parameters.body.lead.key?	string	-
parameters.body.lead.lastLoginTime?	string	-
parameters.body.lead.locale?	string	-
parameters.body.lead.name?	string	-
parameters.body.lead.self?	string	-
parameters.body.lead.timeZone?	string	-
parameters.body.leadUserName?	string	-
parameters.body.name?	string	-
parameters.body.project?	string	-
parameters.body.self?	string	-
parameters.id?	string	The component to delete.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; archived?: boolean; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; deleted?: boolean; description?: string; id?: string; lead?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; leadUserName?: string; name?: string; project?: string; self?: string; }>