Class IssuesApi

IssuesApi - object-oriented interface

Export

Hierarchy

BaseAPI
- IssuesApi

Index

Constructors

Properties

axios basePath configuration

Methods

issuesCreate issuesDestroy issuesList issuesPartialUpdate issuesRetrieve

Constructors

constructor

new IssuesApi(configuration?, basePath?, axios?): IssuesApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns IssuesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

issuesCreate

issuesCreate(requestParameters, options?): Promise<AxiosResponse<IssueRead, any>>
Parameters
- requestParameters: IssuesApiIssuesCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<IssueRead, any>>

Summary
Method creates an issue

Throws

Memberof
IssuesApi
- Defined in api-client/issues-api.ts:717

issuesDestroy

issuesDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: IssuesApiIssuesDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes an issue

Throws

Memberof
IssuesApi
- Defined in api-client/issues-api.ts:729

issuesList

issuesList(requestParameters?, options?): Promise<AxiosResponse<PaginatedIssueReadList, any>>
Parameters
- requestParameters: IssuesApiIssuesListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedIssueReadList, any>>

Summary
Method returns a paginated list of issues

Throws

Memberof
IssuesApi
- Defined in api-client/issues-api.ts:741

issuesPartialUpdate

issuesPartialUpdate(requestParameters, options?): Promise<AxiosResponse<IssueRead, any>>
Parameters
- requestParameters: IssuesApiIssuesPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<IssueRead, any>>

Summary
Methods does a partial update of chosen fields in an issue

Throws

Memberof
IssuesApi
- Defined in api-client/issues-api.ts:753

issuesRetrieve

issuesRetrieve(requestParameters, options?): Promise<AxiosResponse<IssueRead, any>>
Parameters
- requestParameters: IssuesApiIssuesRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<IssueRead, any>>

Summary
Method returns details of an issue

Throws

Memberof
IssuesApi
- Defined in api-client/issues-api.ts:765

Generated using TypeDoc