Class default

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createAndSendRequest deleteWorklog get getForAccount getForIssue getForJiraFilter getForJiraWorklog getForProject getForTeam getForUser getWorklog getWorklogWorkAttributeValues getWorklogWorkAttributeValuesByKey post postWorkAttributeValues putWorklog

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deleteWorklog

deleteWorklog(worklogId: string): Promise<void>
Parameters
- worklogId: string
Returns Promise<void>
- Defined in collections/worklogs.ts:46

getForJiraFilter

getForJiraFilter(jiraFilterId: string, options?: Partial<DateRange & UpdatedFromDate & Pagination>): Promise<PaginatedResultSetResponse<WorklogResponse>>
Parameters
- jiraFilterId: string
- Optional options: Partial<DateRange & UpdatedFromDate & Pagination>
Returns Promise<PaginatedResultSetResponse<WorklogResponse>>
- Defined in collections/worklogs.ts:75

getForJiraWorklog

getForJiraWorklog(jiraWorklogId: string): Promise<WorklogResponse>
Parameters
- jiraWorklogId: string
Returns Promise<WorklogResponse>
- Defined in collections/worklogs.ts:69

getForProject

getForProject(projectKey: string, options?: Partial<DateRange & UpdatedFromDate & Pagination>): Promise<PaginatedResultSetResponse<WorklogResponse>>
Parameters
- projectKey: string
- Optional options: Partial<DateRange & UpdatedFromDate & Pagination>
Returns Promise<PaginatedResultSetResponse<WorklogResponse>>
- Defined in collections/worklogs.ts:104

getForTeam

getForTeam(teamId: string, options?: Partial<DateRange & UpdatedFromDate & Pagination>): Promise<PaginatedResultSetResponse<WorklogResponse>>
Parameters
- teamId: string
- Optional options: Partial<DateRange & UpdatedFromDate & Pagination>
Returns Promise<PaginatedResultSetResponse<WorklogResponse>>
- Defined in collections/worklogs.ts:117

getForUser

getForUser(accountId: string, options?: Partial<DateRange & UpdatedFromDate & Pagination>): Promise<PaginatedResultSetResponse<WorklogResponse>>
Parameters
- accountId: string
- Optional options: Partial<DateRange & UpdatedFromDate & Pagination>
Returns Promise<PaginatedResultSetResponse<WorklogResponse>>
- Defined in collections/worklogs.ts:130

getWorklog

getWorklog(worklogId: string): Promise<WorklogResponse>
Parameters
- worklogId: string
Returns Promise<WorklogResponse>
- Defined in collections/worklogs.ts:32

getWorklogWorkAttributeValues

getWorklogWorkAttributeValues(worklogId: string): Promise<ResultSetResponse<WorklogAttributeValue>>
Parameters
- worklogId: string
Returns Promise<ResultSetResponse<WorklogAttributeValue>>
- Defined in collections/worklogs.ts:52

getWorklogWorkAttributeValuesByKey

getWorklogWorkAttributeValuesByKey(worklogId: string, key: string): Promise<WorklogAttributeValue>
Parameters
- worklogId: string
- key: string
Returns Promise<WorklogAttributeValue>
- Defined in collections/worklogs.ts:60

post

post(worklog: Worklog): Promise<WorklogResponse>
Parameters
- worklog: Worklog
Returns Promise<WorklogResponse>
- Defined in collections/worklogs.ts:25

postWorkAttributeValues

postWorkAttributeValues(worklogAttributeValuesList: WorklogAttributeValues[]): Promise<PaginatedResultSetResponse<WorklogResponse>>
Bulk create work attribute values for worklogs
Parameters
- worklogAttributeValuesList: WorklogAttributeValues[]
Returns Promise<PaginatedResultSetResponse<WorklogResponse>>
- Defined in collections/worklogs.ts:159

putWorklog

putWorklog(worklogId: string, worklog: Worklog): Promise<WorklogResponse>
Parameters
- worklogId: string
- worklog: Worklog
Returns Promise<WorklogResponse>
- Defined in collections/worklogs.ts:36

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deleteWorklog

Parameters

worklogId: string

Returns Promise<void>

get

Parameters

Optional options: Partial<Issues & Projects & DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getForAccount

Parameters

accountKey: string

Optional options: Partial<DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getForIssue

Parameters

key: string

Optional options: Partial<DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getForJiraFilter

Parameters

jiraFilterId: string

Optional options: Partial<DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getForJiraWorklog

Parameters

jiraWorklogId: string

Returns Promise<WorklogResponse>

getForProject

Parameters

projectKey: string

Optional options: Partial<DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getForTeam

Parameters

teamId: string

Optional options: Partial<DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getForUser

Parameters

accountId: string

Optional options: Partial<DateRange & UpdatedFromDate & Pagination>

Returns Promise<PaginatedResultSetResponse<WorklogResponse>>

getWorklog

Parameters

worklogId: string

Returns Promise<WorklogResponse>

getWorklogWorkAttributeValues

Parameters

worklogId: string

Returns Promise<ResultSetResponse<WorklogAttributeValue>>

getWorklogWorkAttributeValuesByKey

Parameters

worklogId: string

key: string

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}

`Optional` options: Partial<Issues & Projects & DateRange & UpdatedFromDate & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDate & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDate & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDate & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDate & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDate & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDate & Pagination>