Skip to content

Commit

Permalink
Partial updated models for Version 2
Browse files Browse the repository at this point in the history
  • Loading branch information
MrRefactoring committed May 7, 2023
1 parent 0a5c4d1 commit cc49964
Show file tree
Hide file tree
Showing 144 changed files with 700 additions and 651 deletions.
14 changes: 7 additions & 7 deletions src/version2/models/actorInput.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ export type ActorInputBean = ActorInput;

export interface ActorInput {
/**
* The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example,
* `"user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"]`.
* The name of the group to add as a default actor. This parameter cannot be used with the `groupId` parameter. As a
* group's name can change,use of `groupId` is recommended. This parameter accepts a comma-separated list. For
* example, `"group":["project-admin", "jira-developers"]`.
*/
user?: string[];
group?: string[];
/**
* The ID of the group to add as a default actor. This parameter cannot be used with the `group` parameter This
* parameter accepts a comma-separated list. For example, `"groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8",
* "0c011f85-69ed-49c4-a801-3b18d0f771bc"]`.
*/
groupId?: string[];
/**
* The name of the group to add as a default actor. This parameter cannot be used with the `groupId` parameter. As a
* group's name can change,use of `groupId` is recommended. This parameter accepts a comma-separated list. For
* example, `"group":["project-admin", "jira-developers"]`.
* The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example,
* `"user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"]`.
*/
group?: string[];
user?: string[];
}
4 changes: 2 additions & 2 deletions src/version2/models/actorsMap.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
export interface ActorsMap {
/** The user account ID of the user to add. */
user?: string[];
/**
* The name of the group to add. This parameter cannot be used with the `groupId` parameter. As a group's name can
* change, use of `groupId` is recommended.
*/
group?: string[];
/** The ID of the group to add. This parameter cannot be used with the `group` parameter. */
groupId?: string[];
/** The user account ID of the user to add. */
user?: string[];
}
8 changes: 4 additions & 4 deletions src/version2/models/announcementBannerConfiguration.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/** Announcement banner configuration. */
export interface AnnouncementBannerConfiguration {
/** The text on the announcement banner. */
message?: string;
/** Hash of the banner data. The client detects updates by comparing hash IDs. */
hashId?: string;
/** Flag indicating if the announcement banner can be dismissed by the user. */
isDismissible?: boolean;
/** Flag indicating if the announcement banner is enabled or not. */
isEnabled?: boolean;
/** Hash of the banner data. The client detects updates by comparing hash IDs. */
hashId?: string;
/** The text on the announcement banner. */
message?: string;
/** Visibility of the announcement banner. */
visibility?: string;
}
4 changes: 2 additions & 2 deletions src/version2/models/announcementBannerConfigurationUpdate.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/** Configuration of the announcement banner. */
export interface AnnouncementBannerConfigurationUpdate {
/** The text on the announcement banner. */
message?: string;
/** Flag indicating if the announcement banner can be dismissed by the user. */
isDismissible?: boolean;
/** Flag indicating if the announcement banner is enabled or not. */
isEnabled?: boolean;
/** The text on the announcement banner. */
message?: string;
/** Visibility of the announcement banner. Can be public or private. */
visibility?: string;
}
4 changes: 2 additions & 2 deletions src/version2/models/application.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
/** The application the linked item is in. */
export interface Application {
/** The name-spaced type of the application, used by registered rendering apps. */
type?: string;
/**
* The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the
* link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the
* tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may
* place links without an application name last.
*/
name?: string;
/** The name-spaced type of the application, used by registered rendering apps. */
type?: string;
}
18 changes: 9 additions & 9 deletions src/version2/models/applicationProperty.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
/** Details of an application property. */
export interface ApplicationProperty {
/** The allowed values, if applicable. */
allowedValues?: string[];
/** The default value of the application property. */
defaultValue?: string;
/** The description of the application property. */
desc?: string;
example?: string;
/** The ID of the application property. The ID and key are the same. */
id?: string;
/** The key of the application property. The ID and key are the same. */
key?: string;
/** The new value. */
value?: string;
/** The name of the application property. */
name?: string;
/** The description of the application property. */
desc?: string;
/** The data type of the application property. */
type?: string;
/** The default value of the application property. */
defaultValue?: string;
example?: string;
/** The allowed values, if applicable. */
allowedValues?: string[];
/** The new value. */
value?: string;
}
32 changes: 16 additions & 16 deletions src/version2/models/applicationRole.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,37 @@ import { GroupName } from './groupName';

/** Details of an application role. */
export interface ApplicationRole {
/** The key of the application role. */
key?: string;
/**
* The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended
* to identify a groups.
*/
groups?: string[];
/** The groups associated with the application role. */
groupDetails?: GroupName[];
/** The display name of the application role. */
name?: string;
/**
* The groups that are granted default access for this application role. As a group's name can change, use of
* `defaultGroupsDetails` is recommended to identify a groups.
*/
defaultGroups?: string[];
/** The groups that are granted default access for this application role. */
defaultGroupsDetails?: GroupName[];
/** Determines whether this application role should be selected by default on user creation. */
selectedByDefault?: boolean;
/** Deprecated. */
defined?: boolean;
/** The groups associated with the application role. */
groupDetails?: GroupName[];
/**
* The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended
* to identify a groups.
*/
groups?: string[];
hasUnlimitedSeats?: boolean;
/** The key of the application role. */
key?: string;
/** The display name of the application role. */
name?: string;
/** The maximum count of users on your license. */
numberOfSeats?: number;
/** Indicates if the application role belongs to Jira platform (`jira-core`). */
platform?: boolean;
/** The count of users remaining on your license. */
remainingSeats?: number;
/** Determines whether this application role should be selected by default on user creation. */
selectedByDefault?: boolean;
/** The number of users counting against your license. */
userCount?: number;
/** The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license. */
userCountDescription?: string;
hasUnlimitedSeats?: boolean;
/** Indicates if the application role belongs to Jira platform (`jira-core`). */
platform?: boolean;
}
4 changes: 2 additions & 2 deletions src/version2/models/associatedItem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ export interface AssociatedItem {
id?: string;
/** The name of the associated record. */
name?: string;
/** The type of the associated record. */
typeName?: string;
/** The ID of the associated parent record. */
parentId?: string;
/** The name of the associated parent record. */
parentName?: string;
/** The type of the associated record. */
typeName?: string;
}
20 changes: 10 additions & 10 deletions src/version2/models/attachment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ import { UserDetails } from './userDetails';

/** Details about an attachment. */
export interface Attachment {
/** The URL of the attachment details response. */
self?: string;
/** The ID of the attachment. */
id: string;
/** The file name of the attachment. */
filename?: string;
author?: UserDetails;
/** The content of the attachment. */
content?: string;
/** The datetime the attachment was created. */
created?: string;
/** The size of the attachment. */
size?: number;
/** The file name of the attachment. */
filename?: string;
/** The ID of the attachment. */
id?: string;
/** The MIME type of the attachment. */
mimeType?: string;
/** The content of the attachment. */
content?: string;
/** The URL of the attachment details response. */
self?: string;
/** The size of the attachment. */
size?: number;
/** The URL of a thumbnail representing the attachment. */
thumbnail?: string;
}
4 changes: 2 additions & 2 deletions src/version2/models/attachmentArchive.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { AttachmentArchiveEntry } from './attachmentArchiveEntry';

export interface AttachmentArchive {
entries?: AttachmentArchiveEntry[];
moreAvailable?: boolean;
totalNumberOfEntriesAvailable?: number;
totalEntryCount?: number;
entries?: AttachmentArchiveEntry[];
totalNumberOfEntriesAvailable?: number;
}
4 changes: 2 additions & 2 deletions src/version2/models/attachmentArchiveEntry.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export interface AttachmentArchiveEntry {
mediaType?: string;
entryIndex?: number;
abbreviatedName?: string;
entryIndex?: number;
mediaType?: string;
name?: string;
size?: number;
}
12 changes: 6 additions & 6 deletions src/version2/models/attachmentArchiveItemReadable.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/** Metadata for an item in an attachment archive. */
export interface AttachmentArchiveItemReadable {
/** The path of the archive item. */
path?: string;
/** The position of the item within the archive. */
index?: number;
/** The size of the archive item. */
size?: string;
/** The MIME type of the archive item. */
mediaType?: string;
/** The label for the archive item. */
label?: string;
/** The MIME type of the archive item. */
mediaType?: string;
/** The path of the archive item. */
path?: string;
/** The size of the archive item. */
size?: string;
}
8 changes: 4 additions & 4 deletions src/version2/models/attachmentArchiveMetadataReadable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ import { AttachmentArchiveItemReadable } from './attachmentArchiveItemReadable';

/** Metadata for an archive (for example a zip) and its contents. */
export interface AttachmentArchiveMetadataReadable {
/** The list of the items included in the archive. */
entries?: AttachmentArchiveItemReadable[];
/** The ID of the attachment. */
id?: number;
/** The MIME type of the attachment. */
mediaType?: string;
/** The name of the archive file. */
name?: string;
/** The list of the items included in the archive. */
entries?: AttachmentArchiveItemReadable[];
/** The number of items included in the archive. */
totalEntryCount?: number;
/** The MIME type of the attachment. */
mediaType?: string;
}
8 changes: 4 additions & 4 deletions src/version2/models/auditRecords.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ import { AuditRecord } from './auditRecord';

/** Container for a list of audit records. */
export interface AuditRecords {
/** The number of audit items skipped before the first item in this list. */
offset?: number;
/** The requested or default limit on the number of audit items to be returned. */
limit?: number;
/** The total number of audit items returned. */
total?: number;
/** The number of audit items skipped before the first item in this list. */
offset?: number;
/** The list of audit items. */
records?: AuditRecord[];
/** The total number of audit items returned. */
total?: number;
}
4 changes: 2 additions & 2 deletions src/version2/models/autoCompleteSuggestion.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/** A field auto-complete suggestion. */
export interface AutoCompleteSuggestion {
/** The value of a suggested item. */
value?: string;
/**
* The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is
* highlighted with the HTML bold tag.
*/
displayName?: string;
/** The value of a suggested item. */
value?: string;
}
4 changes: 2 additions & 2 deletions src/version2/models/availableDashboardGadget.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
export interface AvailableDashboardGadget {
/** The module key of the gadget type. */
moduleKey?: string;
/** The URI of the gadget type. */
uri?: string;
/** The title of the gadget. */
title: string;
/** The URI of the gadget type. */
uri?: string;
}
16 changes: 8 additions & 8 deletions src/version2/models/avatar.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
/** Details of an avatar. */
export interface Avatar {
/** The file name of the avatar icon. Returned for system avatars. */
fileName?: string;
/** The ID of the avatar. */
id: string;
/** Whether the avatar can be deleted. */
isDeletable?: boolean;
/** Whether the avatar is used in Jira. For example, shown as a project's avatar. */
isSelected?: boolean;
/** Whether the avatar is a system avatar. */
isSystemAvatar?: boolean;
/**
* The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars
* this is the appropriate identifier, such as the ID for a project or the account ID for a user.
*/
owner?: string;
/** Whether the avatar is a system avatar. */
isSystemAvatar?: boolean;
/** Whether the avatar is used in Jira. For example, shown as a project's avatar. */
isSelected?: boolean;
/** Whether the avatar can be deleted. */
isDeletable?: boolean;
/** The file name of the avatar icon. Returned for system avatars. */
fileName?: string;
/** The list of avatar icon URLs. */
urls?: {};
}
4 changes: 2 additions & 2 deletions src/version2/models/avatars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { Avatar } from './avatar';

/** Details about system and custom avatars. */
export interface Avatars {
/** System avatars list. */
system?: Avatar[];
/** Custom avatars list. */
custom?: Avatar[];
/** System avatars list. */
system?: Avatar[];
}
10 changes: 5 additions & 5 deletions src/version2/models/bulkIssuePropertyUpdateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@ import { IssueFilterForBulkPropertySet } from './issueFilterForBulkPropertySet';

/** Bulk issue property update request details. */
export interface BulkIssuePropertyUpdateRequest {
/**
* The value of the property. The value must be a [valid](https://tools.ietf.org/html/rfc4627), non-empty JSON blob.
* The maximum length is 32768 characters.
*/
value?: any;
/**
* EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an
* object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables
Expand All @@ -15,4 +10,9 @@ export interface BulkIssuePropertyUpdateRequest {
*/
expression?: string;
filter?: IssueFilterForBulkPropertySet;
/**
* The value of the property. The value must be a [valid](https://tools.ietf.org/html/rfc4627), non-empty JSON blob.
* The maximum length is 32768 characters.
*/
value?: any;
}
2 changes: 1 addition & 1 deletion src/version2/models/bulkOperationErrorResult.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ErrorCollection } from './errorCollection';

export interface BulkOperationErrorResult {
status?: number;
elementErrors?: ErrorCollection;
failedElementNumber?: number;
status?: number;
}
Loading

0 comments on commit cc49964

Please sign in to comment.