Class Version3Client

Hierarchy (view full)

BaseClient
- Version3Client

Index

Constructors

Properties

announcementBanner appMigration appProperties applicationRoles auditRecords avatars config dashboards dynamicModules filterSharing filters groupAndUserPicker groups instanceInformation issueAttachments issueCommentProperties issueComments issueCustomFieldConfigurationApps issueCustomFieldContexts issueCustomFieldOptions issueCustomFieldOptionsApps issueCustomFieldValuesApps issueFieldConfigurations issueFields issueLinkTypes issueLinks issueNavigatorSettings issueNotificationSchemes issuePriorities issueProperties issueRemoteLinks issueResolutions issueSearch issueSecurityLevel issueSecuritySchemes issueTypeProperties issueTypeSchemes issueTypeScreenSchemes issueTypes issueVotes issueWatchers issueWorklogProperties issueWorklogs issues jiraExpressions jiraSettings jql jqlFunctionsApps labels licenseMetrics myself permissionSchemes permissions projectAvatars projectCategories projectComponents projectEmail projectFeatures projectKeyAndNameValidation projectPermissionSchemes projectProperties projectRoleActors projectRoles projectTypes projectVersions projects screenSchemes screenTabFields screenTabs screens serverInfo status tasks timeTracking uiModificationsApps userProperties userSearch users webhooks workflowSchemeDrafts workflowSchemeProjectAssociations workflowSchemes workflowStatusCategories workflowStatuses workflowTransitionProperties workflowTransitionRules workflows

Methods

encode handleFailedResponse handleSuccessResponse paramSerializer removeUndefinedProperties sendRequest sendRequestFullResponse

Constructors

constructor

new Version3Client(config): Version3Client
Parameters
- config: Config
Returns Version3Client
Inherited from BaseClient.constructor
- Defined in src/clients/baseClient.ts:16

Properties

announcementBanner

announcementBanner: Version3.AnnouncementBanner = ...

appMigration

appMigration: Version3.AppMigration = ...

appProperties

appProperties: Version3.AppProperties = ...

applicationRoles

applicationRoles: Version3.ApplicationRoles = ...

auditRecords

auditRecords: Version3.AuditRecords = ...

avatars

avatars: Version3.Avatars = ...

`Protected` `Readonly` config

config: Config

dashboards

dashboards: Version3.Dashboards = ...

dynamicModules

dynamicModules: Version3.DynamicModules = ...

filterSharing

filterSharing: Version3.FilterSharing = ...

filters

filters: Version3.Filters = ...

groupAndUserPicker

groupAndUserPicker: Version3.GroupAndUserPicker = ...

groups

groups: Version3.Groups = ...

instanceInformation

instanceInformation: InstanceInformation = ...

issueAttachments

issueAttachments: Version3.IssueAttachments = ...

issueCommentProperties

issueCommentProperties: Version3.IssueCommentProperties = ...

issueComments

issueComments: Version3.IssueComments = ...

issueCustomFieldConfigurationApps

issueCustomFieldConfigurationApps: Version3.IssueCustomFieldConfigurationApps = ...

issueCustomFieldContexts

issueCustomFieldContexts: Version3.IssueCustomFieldContexts = ...

issueCustomFieldOptions

issueCustomFieldOptions: Version3.IssueCustomFieldOptions = ...

issueCustomFieldOptionsApps

issueCustomFieldOptionsApps: Version3.IssueCustomFieldOptionsApps = ...

issueCustomFieldValuesApps

issueCustomFieldValuesApps: Version3.IssueCustomFieldValuesApps = ...

issueFieldConfigurations

issueFieldConfigurations: Version3.IssueFieldConfigurations = ...

issueFields

issueFields: Version3.IssueFields = ...

issueLinkTypes

issueLinkTypes: Version3.IssueLinkTypes = ...

issueLinks

issueLinks: Version3.IssueLinks = ...

issueNavigatorSettings

issueNavigatorSettings: Version3.IssueNavigatorSettings = ...

issueNotificationSchemes

issueNotificationSchemes: Version3.IssueNotificationSchemes = ...

issuePriorities

issuePriorities: Version3.IssuePriorities = ...

issueProperties

issueProperties: Version3.IssueProperties = ...

issueRemoteLinks

issueRemoteLinks: Version3.IssueRemoteLinks = ...

issueResolutions

issueResolutions: Version3.IssueResolutions = ...

issueSearch

issueSearch: Version3.IssueSearch = ...

issueSecurityLevel

issueSecurityLevel: Version3.IssueSecurityLevel = ...

issueSecuritySchemes

issueSecuritySchemes: Version3.IssueSecuritySchemes = ...

issueTypeProperties

issueTypeProperties: Version3.IssueTypeProperties = ...

issueTypeSchemes

issueTypeSchemes: Version3.IssueTypeSchemes = ...

issueTypeScreenSchemes

issueTypeScreenSchemes: Version3.IssueTypeScreenSchemes = ...

issueTypes

issueTypes: Version3.IssueTypes = ...

issueVotes

issueVotes: Version3.IssueVotes = ...

issueWatchers

issueWatchers: Version3.IssueWatchers = ...

issueWorklogProperties

issueWorklogProperties: Version3.IssueWorklogProperties = ...

issueWorklogs

issueWorklogs: Version3.IssueWorklogs = ...

issues

issues: Version3.Issues = ...

jiraExpressions

jiraExpressions: Version3.JiraExpressions = ...

jiraSettings

jiraSettings: Version3.JiraSettings = ...

jql

jql: Version3.JQL = ...

jqlFunctionsApps

jqlFunctionsApps: Version3.JqlFunctionsApps = ...

labels

labels: Version3.Labels = ...

licenseMetrics

licenseMetrics: Version3.LicenseMetrics = ...

myself

myself: Version3.Myself = ...

permissionSchemes

permissionSchemes: Version3.PermissionSchemes = ...

permissions

permissions: Version3.Permissions = ...

projectAvatars

projectAvatars: Version3.ProjectAvatars = ...

projectCategories

projectCategories: Version3.ProjectCategories = ...

projectComponents

projectComponents: Version3.ProjectComponents = ...

projectEmail

projectEmail: Version3.ProjectEmail = ...

projectFeatures

projectFeatures: Version3.ProjectFeatures = ...

projectKeyAndNameValidation

projectKeyAndNameValidation: Version3.ProjectKeyAndNameValidation = ...

projectPermissionSchemes

projectPermissionSchemes: Version3.ProjectPermissionSchemes = ...

projectProperties

projectProperties: Version3.ProjectProperties = ...

projectRoleActors

projectRoleActors: Version3.ProjectRoleActors = ...

projectRoles

projectRoles: Version3.ProjectRoles = ...

projectTypes

projectTypes: Version3.ProjectTypes = ...

projectVersions

projectVersions: Version3.ProjectVersions = ...

projects

projects: Version3.Projects = ...

screenSchemes

screenSchemes: Version3.ScreenSchemes = ...

screenTabFields

screenTabFields: Version3.ScreenTabFields = ...

screenTabs

screenTabs: Version3.ScreenTabs = ...

screens

screens: Version3.Screens = ...

serverInfo

serverInfo: Version3.ServerInfo = ...

status

status: Version3.Status = ...

tasks

tasks: Version3.Tasks = ...

timeTracking

timeTracking: Version3.TimeTracking = ...

uiModificationsApps

uiModificationsApps: Version3.UIModificationsApps = ...

userProperties

userProperties: Version3.UserProperties = ...

userSearch

userSearch: Version3.UserSearch = ...

users

users: Version3.Users = ...

webhooks

webhooks: Version3.Webhooks = ...

workflowSchemeDrafts

workflowSchemeDrafts: Version3.WorkflowSchemeDrafts = ...

workflowSchemeProjectAssociations

workflowSchemeProjectAssociations: Version3.WorkflowSchemeProjectAssociations = ...

workflowSchemes

workflowSchemes: Version3.WorkflowSchemes = ...

workflowStatusCategories

workflowStatusCategories: Version3.WorkflowStatusCategories = ...

workflowStatuses

workflowStatuses: Version3.WorkflowStatuses = ...

workflowTransitionProperties

workflowTransitionProperties: Version3.WorkflowTransitionProperties = ...

workflowTransitionRules

workflowTransitionRules: Version3.WorkflowTransitionRules = ...

workflows

workflows: Version3.Workflows = ...

Methods

`Protected` encode

encode(value): string
Parameters
- value: string
Returns string
Inherited from BaseClient.encode
- Defined in src/clients/baseClient.ts:70

handleFailedResponse

handleFailedResponse<T>(e, callback?): void
Type Parameters
- T
Parameters
- e: unknown
- Optional callback: Callback<T>
Returns void
Inherited from BaseClient.handleFailedResponse
- Defined in src/clients/baseClient.ts:121

handleSuccessResponse

handleSuccessResponse<T>(response, callback?): void | T
Type Parameters
- T
Parameters
- response: any
- Optional callback: Callback<T>
Returns void | T
Inherited from BaseClient.handleSuccessResponse
- Defined in src/clients/baseClient.ts:110

`Protected` paramSerializer

paramSerializer(parameters): string
Parameters
- parameters: Record<string, any>
Returns string
Inherited from BaseClient.paramSerializer
- Defined in src/clients/baseClient.ts:38

`Protected` removeUndefinedProperties

removeUndefinedProperties(obj): Record<string, any>
Parameters
- obj: Record<string, any>
Returns Record<string, any>
Inherited from BaseClient.removeUndefinedProperties
- Defined in src/clients/baseClient.ts:80

sendRequest

sendRequest<T>(requestConfig, callback, telemetryData?): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
- Optional telemetryData: any
Returns Promise<T>
Inherited from BaseClient.sendRequest
- Defined in src/clients/baseClient.ts:86
sendRequest<T>(requestConfig, callback, telemetryData?): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
- Optional telemetryData: any
Returns Promise<void>
Inherited from BaseClient.sendRequest
- Defined in src/clients/baseClient.ts:87

sendRequestFullResponse

sendRequestFullResponse<T>(requestConfig): Promise<AxiosResponse<T, any>>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
Returns Promise<AxiosResponse<T, any>>
Inherited from BaseClient.sendRequestFullResponse
- Defined in src/clients/baseClient.ts:98