Class AgileClient

Hierarchy (View Summary)

BaseClient
- AgileClient

Constructors

constructor

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

Properties

backlog

backlog: Backlog = ...

board

board: Agile.Board = ...

builds

builds: Builds = ...

`Protected` `Readonly`config

config: Config

deployments

deployments: Deployments = ...

developmentInformation

developmentInformation: DevelopmentInformation = ...

devopsComponents

devopsComponents: DevopsComponents = ...

epic

epic: Agile.Epic = ...

featureFlags

featureFlags: FeatureFlags = ...

issue

issue: Agile.Issue = ...

operations

operations: Agile.Operations = ...

remoteLinks

remoteLinks: RemoteLinks = ...

securityInformation

securityInformation: SecurityInformation = ...

sprint

sprint: Agile.Sprint = ...

Methods

`Protected`encode

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

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:121

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:110

`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:38

`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:80

sendRequest

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

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:98