Class Version2Client

Hierarchy (View Summary)

BaseClient
- Version2Client

Index

Constructors

Properties

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

Methods

encode handleFailedResponse handleSuccessResponse paramSerializer removeUndefinedProperties sendRequest sendRequestFullResponse

Constructors

constructor

new Version2Client(
    config: {
        authentication?:
            | { basic: { apiToken: string; email: string } }
            | { oauth2: { accessToken: string } };
        baseRequestConfig?: any;
        host: string;
        middlewares?: {
            onError?: (...args: [any, ...unknown[]]) => void;
            onResponse?: (...args: [any, ...unknown[]]) => void;
        };
        noCheckAtlassianToken?: boolean;
        strictGDPR?: boolean;
    },
): Version2.Version2Client
Parameters
- config: {
      authentication?:
          | { basic: { apiToken: string; email: string } }
          | { oauth2: { accessToken: string } };
      baseRequestConfig?: any;
      host: string;
      middlewares?: {
          onError?: (...args: [any, ...unknown[]]) => void;
          onResponse?: (...args: [any, ...unknown[]]) => void;
      };
      noCheckAtlassianToken?: boolean;
      strictGDPR?: boolean;
  }
  - Optionalauthentication?:
    | { basic: { apiToken: string; email: string } }
    | { oauth2: { accessToken: string } }
  - OptionalbaseRequestConfig?: any
  - host: string
  - Optionalmiddlewares?: {
    onError?: (...args: [any, ...unknown[]]) => void;
    onResponse?: (...args: [any, ...unknown[]]) => void;
    }
  - OptionalnoCheckAtlassianToken?: boolean
    Adds 'X-Atlassian-Token': 'no-check' to each request header
  - OptionalstrictGDPR?: boolean
Returns Version2.Version2Client
Inherited from BaseClient.constructor
- Defined in src/clients/baseClient.ts:20

Properties

announcementBanner

announcementBanner: Version2.AnnouncementBanner = ...

appDataPolicies

appDataPolicies: Version2.AppDataPolicies = ...

applicationRoles

applicationRoles: Version2.ApplicationRoles = ...

appMigration

appMigration: Version2.AppMigration = ...

appProperties

appProperties: Version2.AppProperties = ...

auditRecords

auditRecords: Version2.AuditRecords = ...

avatars

avatars: Version2.Avatars = ...

classificationLevels

classificationLevels: Version2.ClassificationLevels = ...

`Protected` `Readonly`config

config: {
    authentication?:
        | { basic: { apiToken: string; email: string } }
        | { oauth2: { accessToken: string } };
    baseRequestConfig?: any;
    host: string;
    middlewares?: {
        onError?: (...args: [any, ...unknown[]]) => void;
        onResponse?: (...args: [any, ...unknown[]]) => void;
    };
    noCheckAtlassianToken?: boolean;
    strictGDPR?: boolean;
}

Type declaration

Optionalauthentication?:
| { basic: { apiToken: string; email: string } }
| { oauth2: { accessToken: string } }
OptionalbaseRequestConfig?: any
host: string
Optionalmiddlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}
OptionalnoCheckAtlassianToken?: boolean
Adds 'X-Atlassian-Token': 'no-check' to each request header
OptionalstrictGDPR?: boolean

dashboards

dashboards: Version2.Dashboards = ...

dynamicModules

dynamicModules: Version2.DynamicModules = ...

filters

filters: Version2.Filters = ...

filterSharing

filterSharing: Version2.FilterSharing = ...

groupAndUserPicker

groupAndUserPicker: Version2.GroupAndUserPicker = ...

groups

groups: Version2.Groups = ...

issueAttachments

issueAttachments: Version2.IssueAttachments = ...

issueCommentProperties

issueCommentProperties: Version2.IssueCommentProperties = ...

issueComments

issueComments: Version2.IssueComments = ...

issueCustomFieldAssociations

issueCustomFieldAssociations: Version2.IssueCustomFieldAssociations = ...

issueCustomFieldConfigurationApps

issueCustomFieldConfigurationApps: Version2.IssueCustomFieldConfigurationApps = ...

issueCustomFieldContexts

issueCustomFieldContexts: Version2.IssueCustomFieldContexts = ...

issueCustomFieldOptions

issueCustomFieldOptions: Version2.IssueCustomFieldOptions = ...

issueCustomFieldOptionsApps

issueCustomFieldOptionsApps: Version2.IssueCustomFieldOptionsApps = ...

issueCustomFieldValuesApps

issueCustomFieldValuesApps: Version2.IssueCustomFieldValuesApps = ...

issueFieldConfigurations

issueFieldConfigurations: Version2.IssueFieldConfigurations = ...

issueFields

issueFields: Version2.IssueFields = ...

issueLinks

issueLinks: Version2.IssueLinks = ...

issueLinkTypes

issueLinkTypes: Version2.IssueLinkTypes = ...

issueNavigatorSettings

issueNavigatorSettings: Version2.IssueNavigatorSettings = ...

issueNotificationSchemes

issueNotificationSchemes: Version2.IssueNotificationSchemes = ...

issuePriorities

issuePriorities: Version2.IssuePriorities = ...

issueProperties

issueProperties: Version2.IssueProperties = ...

issueRemoteLinks

issueRemoteLinks: Version2.IssueRemoteLinks = ...

issueResolutions

issueResolutions: Version2.IssueResolutions = ...

issues

issues: Version2.Issues = ...

issueSearch

issueSearch: Version2.IssueSearch = ...

issueSecurityLevel

issueSecurityLevel: Version2.IssueSecurityLevel = ...

issueSecuritySchemes

issueSecuritySchemes: Version2.IssueSecuritySchemes = ...

issueTypeProperties

issueTypeProperties: Version2.IssueTypeProperties = ...

issueTypes

issueTypes: Version2.IssueTypes = ...

issueTypeSchemes

issueTypeSchemes: Version2.IssueTypeSchemes = ...

issueTypeScreenSchemes

issueTypeScreenSchemes: Version2.IssueTypeScreenSchemes = ...

issueVotes

issueVotes: Version2.IssueVotes = ...

issueWatchers

issueWatchers: Version2.IssueWatchers = ...

issueWorklogProperties

issueWorklogProperties: Version2.IssueWorklogProperties = ...

issueWorklogs

issueWorklogs: Version2.IssueWorklogs = ...

jiraExpressions

jiraExpressions: Version2.JiraExpressions = ...

jiraSettings

jiraSettings: Version2.JiraSettings = ...

jql

jql: Version2.JQL = ...

jqlFunctionsApps

jqlFunctionsApps: Version2.JqlFunctionsApps = ...

labels

labels: Version2.Labels = ...

licenseMetrics

licenseMetrics: Version2.LicenseMetrics = ...

myself

myself: Version2.Myself = ...

permissions

permissions: Version2.Permissions = ...

permissionSchemes

permissionSchemes: Version2.PermissionSchemes = ...

plans

plans: Version2.Plans = ...

prioritySchemes

prioritySchemes: Version2.PrioritySchemes = ...

projectAvatars

projectAvatars: Version2.ProjectAvatars = ...

projectCategories

projectCategories: Version2.ProjectCategories = ...

projectClassificationLevels

projectClassificationLevels: Version2.ProjectClassificationLevels = ...

projectComponents

projectComponents: Version2.ProjectComponents = ...

projectEmail

projectEmail: Version2.ProjectEmail = ...

projectFeatures

projectFeatures: Version2.ProjectFeatures = ...

projectKeyAndNameValidation

projectKeyAndNameValidation: Version2.ProjectKeyAndNameValidation = ...

projectPermissionSchemes

projectPermissionSchemes: Version2.ProjectPermissionSchemes = ...

projectProperties

projectProperties: Version2.ProjectProperties = ...

projectRoleActors

projectRoleActors: Version2.ProjectRoleActors = ...

projectRoles

projectRoles: Version2.ProjectRoles = ...

projects

projects: Version2.Projects = ...

projectTemplates

projectTemplates: Version2.ProjectTemplates = ...

projectTypes

projectTypes: Version2.ProjectTypes = ...

projectVersions

projectVersions: Version2.ProjectVersions = ...

screens

screens: Version2.Screens = ...

screenSchemes

screenSchemes: Version2.ScreenSchemes = ...

screenTabFields

screenTabFields: Version2.ScreenTabFields = ...

screenTabs

screenTabs: Version2.ScreenTabs = ...

serverInfo

serverInfo: Version2.ServerInfo = ...

serviceRegistry

serviceRegistry: Version2.ServiceRegistry = ...

status

status: Version2.Status = ...

tasks

tasks: Version2.Tasks = ...

teamsInPlan

teamsInPlan: Version2.TeamsInPlan = ...

timeTracking

timeTracking: Version2.TimeTracking = ...

uiModificationsApps

uiModificationsApps: Version2.UIModificationsApps = ...

userNavProperties

userNavProperties: Version2.UserNavProperties = ...

userProperties

userProperties: Version2.UserProperties = ...

users

users: Version2.Users = ...

userSearch

userSearch: Version2.UserSearch = ...

webhooks

webhooks: Version2.Webhooks = ...

workflows

workflows: Version2.Workflows = ...

workflowSchemeDrafts

workflowSchemeDrafts: Version2.WorkflowSchemeDrafts = ...

workflowSchemeProjectAssociations

workflowSchemeProjectAssociations: Version2.WorkflowSchemeProjectAssociations = ...

workflowSchemes

workflowSchemes: Version2.WorkflowSchemes = ...

workflowStatusCategories

workflowStatusCategories: Version2.WorkflowStatusCategories = ...

workflowStatuses

workflowStatuses: Version2.WorkflowStatuses = ...

workflowTransitionProperties

workflowTransitionProperties: Version2.WorkflowTransitionProperties = ...

workflowTransitionRules

workflowTransitionRules: Version2.WorkflowTransitionRules = ...

Methods

`Protected`encode

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

handleFailedResponse

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

handleSuccessResponse

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

`Protected`paramSerializer

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

`Protected`removeUndefinedProperties

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

sendRequest

sendRequest<T>(requestConfig: RequestConfig, callback: never): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
Returns Promise<T>
Inherited from BaseClient.sendRequest
- Defined in src/clients/baseClient.ts:89
sendRequest<T>(
requestConfig: RequestConfig,
callback: Callback<T>,
): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
Returns Promise<void>
Inherited from BaseClient.sendRequest
- Defined in src/clients/baseClient.ts:90

sendRequestFullResponse

sendRequestFullResponse<T>(
requestConfig: 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:101

Class Version2Client

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalauthentication?: | { basic: { apiToken: string; email: string } } | { oauth2: { accessToken: string } }

OptionalbaseRequestConfig?: any

host: string

Optionalmiddlewares?: { onError?: (...args: [any, ...unknown[]]) => void; onResponse?: (...args: [any, ...unknown[]]) => void;}

OptionalnoCheckAtlassianToken?: boolean

OptionalstrictGDPR?: boolean

Returns Version2.Version2Client

Properties

announcementBanner

appDataPolicies

applicationRoles

appMigration

appProperties

auditRecords

avatars

classificationLevels

Protected Readonlyconfig

Type declaration

Optionalauthentication?: | { basic: { apiToken: string; email: string } } | { oauth2: { accessToken: string } }

OptionalbaseRequestConfig?: any

host: string

Optionalmiddlewares?: { onError?: (...args: [any, ...unknown[]]) => void; onResponse?: (...args: [any, ...unknown[]]) => void;}

OptionalnoCheckAtlassianToken?: boolean

OptionalstrictGDPR?: boolean

dashboards

dynamicModules

filters

filterSharing

groupAndUserPicker

groups

issueAttachments

issueCommentProperties

issueComments

issueCustomFieldAssociations

issueCustomFieldConfigurationApps

issueCustomFieldContexts

issueCustomFieldOptions

issueCustomFieldOptionsApps

issueCustomFieldValuesApps

issueFieldConfigurations

issueFields

issueLinks

issueLinkTypes

issueNavigatorSettings

issueNotificationSchemes

issuePriorities

issueProperties

issueRemoteLinks

issueResolutions

issues

issueSearch

issueSecurityLevel

issueSecuritySchemes

issueTypeProperties

issueTypes

issueTypeSchemes

issueTypeScreenSchemes

issueVotes

issueWatchers

issueWorklogProperties

issueWorklogs

jiraExpressions

jiraSettings

jql

jqlFunctionsApps

labels

licenseMetrics

myself

permissions

permissionSchemes

plans

`Optional`authentication?:
| { basic: { apiToken: string; email: string } }
| { oauth2: { accessToken: string } }

`Optional`baseRequestConfig?: any

`Optional`middlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}

`Optional`noCheckAtlassianToken?: boolean

`Optional`strictGDPR?: boolean

`Protected` `Readonly`config

`Optional`authentication?:
| { basic: { apiToken: string; email: string } }
| { oauth2: { accessToken: string } }

`Optional`baseRequestConfig?: any

`Optional`middlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}

`Optional`noCheckAtlassianToken?: boolean

`Optional`strictGDPR?: boolean

`Protected`encode

`Protected`paramSerializer

`Protected`removeUndefinedProperties