UNPKG

2.77 kBTypeScriptView Raw
1import { Epic } from './api/epic.d.ts';
2
3export = JiraClient;
4
5interface IConfig {
6 host: string;
7 port?: number;
8
9 protocol?: string;
10 path_prefix?: string;
11 strictSSL?: boolean;
12 version?: string;
13 basic_auth?: {
14 username?: string;
15 password?: string;
16 base64?: string;
17 };
18 oauth?: {
19 consumer_key: string;
20 private_key: string;
21 token: string;
22 token_secret: string;
23 }
24 cookie_jar?: any;
25 promise?: PromiseLike<any>;
26 request?: any;
27 rejectUnauthorized?: any;
28}
29
30declare class JiraClient {
31 constructor(config: IConfig);
32
33 public applicationProperties: any;
34 public attachment: any;
35 public auditing: any;
36 public auth: any;
37 public avatar: any;
38 public backlog: any;
39 public board: any;
40 public comment: any;
41 public component: any;
42 public customFieldOption: any;
43 public dashboard: any;
44 public epic: Epic;
45 public field: any;
46 public filter: any;
47 public group: any;
48 public groupUserPicker: any;
49 public groups: any;
50 public issue: any;
51 public issueLink: any;
52 public issueLinkType: any;
53 public issueType: any;
54 public jql: any;
55 public labels: any;
56 public licenseRole: any;
57 public licenseValidator: any;
58 public myPermissions: any;
59 public myPreferences: any;
60 public myself: any;
61 public password: any;
62 public permissions: any;
63 public permissionScheme: any;
64 public priority: any;
65 public project: any;
66 public projectCategory: any;
67 public projectValidate: any;
68 public reindex: any;
69 public resolution: any;
70 public roles: any;
71 public screens: any;
72 public search: any;
73 public securityLevel: any;
74 public serverInfo: any;
75 public settings: any;
76 public sprint: any;
77 public status: any;
78 public statusCategory: any;
79 public user: any;
80 public version: any;
81 public webhook: any;
82 public workflow: any;
83 public workflowScheme: any;
84 public worklog: any;
85
86 public buildAgileURL(path: string, forcedVersion?: number | string): string;
87 public buildAuthURL(path: string, forcedVersion?: number | string): string;
88 public buildURL(path: string, forcedVersion?: number | string): string;
89 public buildWebhookURL(path: string, forcedVersion?: number | string): string;
90 public makeRequest(options: { [key: string]: any }, callback?: any, successString?: string): any;
91}
92
93declare namespace JiraClient {
94 namespace oauth_util {
95 function getAuthorizeURL(config: any, callback: any): any;
96
97 function swapRequestTokenWithAccessToken(config: any, callback: any): void;
98 }
99}