jira.js
    Preparing search index...

    Function updateComponent

    • 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

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

          The component to delete.

      • Optionaloptions: RequestOptions

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