@makeplane/plane-node-sdk 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish-node-sdk.yml +22 -3
- package/.openapi-generator/FILES +2 -1
- package/README.md +2 -2
- package/dist/apis/WorkItemPropertiesApi.d.ts +7 -7
- package/dist/apis/WorkItemPropertiesApi.js +3 -3
- package/dist/apis/WorkItemsApi.d.ts +3 -3
- package/dist/apis/WorkItemsApi.js +1 -1
- package/dist/models/IssueDetail.d.ts +211 -0
- package/dist/models/IssueDetail.js +108 -0
- package/dist/models/IssueExpand.d.ts +4 -6
- package/dist/models/IssueExpand.js +2 -4
- package/dist/models/IssuePropertyValueAPIDetail.d.ts +39 -0
- package/dist/models/IssuePropertyValueAPIDetail.js +54 -0
- package/dist/models/IssueSearch.d.ts +3 -4
- package/dist/models/index.d.ts +2 -1
- package/dist/models/index.js +2 -1
- package/dist/oauth/api.d.ts +1 -1
- package/dist/oauth/api.js +6 -4
- package/package.json +1 -1
- package/src/apis/WorkItemPropertiesApi.ts +12 -9
- package/src/apis/WorkItemsApi.ts +6 -3
- package/src/models/IssueDetail.ts +319 -0
- package/src/models/IssueExpand.ts +6 -20
- package/src/models/IssuePropertyValueAPIDetail.ts +76 -0
- package/src/models/IssueSearch.ts +3 -4
- package/src/models/index.ts +2 -1
- package/src/oauth/api.ts +7 -5
- package/dist/models/LabelLite.d.ts +0 -46
- package/dist/models/LabelLite.js +0 -53
- package/src/models/LabelLite.ts +0 -83
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Plane REST API
|
|
5
|
+
* The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
|
|
6
|
+
*
|
|
7
|
+
* The version of the API Spec: 0.0.1
|
|
8
|
+
* Contact: support@plane.so
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated.
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import { mapValues } from '../runtime';
|
|
15
|
+
/**
|
|
16
|
+
* Serializer for aggregated issue property values response.
|
|
17
|
+
* This serializer handles the response format from the query_annotator method
|
|
18
|
+
* which returns property_id and values (ArrayAgg of property values).
|
|
19
|
+
* @export
|
|
20
|
+
* @interface IssuePropertyValueAPIDetail
|
|
21
|
+
*/
|
|
22
|
+
export interface IssuePropertyValueAPIDetail {
|
|
23
|
+
/**
|
|
24
|
+
* The ID of the issue property
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof IssuePropertyValueAPIDetail
|
|
27
|
+
*/
|
|
28
|
+
propertyId: string;
|
|
29
|
+
/**
|
|
30
|
+
* List of aggregated property values for the given property
|
|
31
|
+
* @type {Array<string>}
|
|
32
|
+
* @memberof IssuePropertyValueAPIDetail
|
|
33
|
+
*/
|
|
34
|
+
values: Array<string>;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the IssuePropertyValueAPIDetail interface.
|
|
39
|
+
*/
|
|
40
|
+
export function instanceOfIssuePropertyValueAPIDetail(value: object): value is IssuePropertyValueAPIDetail {
|
|
41
|
+
if (!('propertyId' in value) || value['propertyId'] === undefined) return false;
|
|
42
|
+
if (!('values' in value) || value['values'] === undefined) return false;
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export function IssuePropertyValueAPIDetailFromJSON(json: any): IssuePropertyValueAPIDetail {
|
|
47
|
+
return IssuePropertyValueAPIDetailFromJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function IssuePropertyValueAPIDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssuePropertyValueAPIDetail {
|
|
51
|
+
if (json == null) {
|
|
52
|
+
return json;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
|
|
56
|
+
'propertyId': json['property_id'],
|
|
57
|
+
'values': json['values'],
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export function IssuePropertyValueAPIDetailToJSON(json: any): IssuePropertyValueAPIDetail {
|
|
62
|
+
return IssuePropertyValueAPIDetailToJSONTyped(json, false);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function IssuePropertyValueAPIDetailToJSONTyped(value?: IssuePropertyValueAPIDetail | null, ignoreDiscriminator: boolean = false): any {
|
|
66
|
+
if (value == null) {
|
|
67
|
+
return value;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
return {
|
|
71
|
+
|
|
72
|
+
'property_id': value['propertyId'],
|
|
73
|
+
'values': value['values'],
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
|
|
@@ -21,16 +21,15 @@ import {
|
|
|
21
21
|
} from './IssueSearchItem';
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Search results for work items.
|
|
25
25
|
*
|
|
26
|
-
* Provides
|
|
27
|
-
* project context, and workspace information for search API responses.
|
|
26
|
+
* Provides list of issues with their identifiers, names, and project context.
|
|
28
27
|
* @export
|
|
29
28
|
* @interface IssueSearch
|
|
30
29
|
*/
|
|
31
30
|
export interface IssueSearch {
|
|
32
31
|
/**
|
|
33
|
-
*
|
|
32
|
+
*
|
|
34
33
|
* @type {Array<IssueSearchItem>}
|
|
35
34
|
* @memberof IssueSearch
|
|
36
35
|
*/
|
package/src/models/index.ts
CHANGED
|
@@ -19,6 +19,7 @@ export * from './IssueAttachment';
|
|
|
19
19
|
export * from './IssueAttachmentUploadRequest';
|
|
20
20
|
export * from './IssueComment';
|
|
21
21
|
export * from './IssueCommentCreateRequest';
|
|
22
|
+
export * from './IssueDetail';
|
|
22
23
|
export * from './IssueExpand';
|
|
23
24
|
export * from './IssueForIntakeRequest';
|
|
24
25
|
export * from './IssueLink';
|
|
@@ -28,6 +29,7 @@ export * from './IssuePropertyAPIRequest';
|
|
|
28
29
|
export * from './IssuePropertyOptionAPI';
|
|
29
30
|
export * from './IssuePropertyOptionAPIRequest';
|
|
30
31
|
export * from './IssuePropertyValueAPI';
|
|
32
|
+
export * from './IssuePropertyValueAPIDetail';
|
|
31
33
|
export * from './IssuePropertyValueAPIRequest';
|
|
32
34
|
export * from './IssueRequest';
|
|
33
35
|
export * from './IssueSearch';
|
|
@@ -38,7 +40,6 @@ export * from './IssueWorkLogAPI';
|
|
|
38
40
|
export * from './IssueWorkLogAPIRequest';
|
|
39
41
|
export * from './Label';
|
|
40
42
|
export * from './LabelCreateUpdateRequest';
|
|
41
|
-
export * from './LabelLite';
|
|
42
43
|
export * from './Module';
|
|
43
44
|
export * from './ModuleCreateRequest';
|
|
44
45
|
export * from './ModuleIssue';
|
package/src/oauth/api.ts
CHANGED
|
@@ -12,17 +12,19 @@ export class OAuthApi extends runtime.BaseAPI {
|
|
|
12
12
|
|
|
13
13
|
constructor(
|
|
14
14
|
configuration: runtime.Configuration,
|
|
15
|
-
oauthConfig
|
|
15
|
+
oauthConfig?: {
|
|
16
16
|
clientId: string;
|
|
17
17
|
clientSecret: string;
|
|
18
18
|
redirectUri: string;
|
|
19
19
|
}
|
|
20
20
|
) {
|
|
21
21
|
super(configuration);
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
22
|
+
if (oauthConfig) {
|
|
23
|
+
this.clientId = oauthConfig.clientId;
|
|
24
|
+
this.clientSecret = oauthConfig.clientSecret;
|
|
25
|
+
this.redirectUri = oauthConfig.redirectUri;
|
|
26
|
+
this.baseUrl = configuration.basePath || "https://api.plane.so";
|
|
27
|
+
}
|
|
26
28
|
}
|
|
27
29
|
|
|
28
30
|
/**
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The Plane REST API
|
|
3
|
-
* The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
|
|
4
|
-
*
|
|
5
|
-
* The version of the API Spec: 0.0.1
|
|
6
|
-
* Contact: support@plane.so
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated.
|
|
9
|
-
* Do not edit the class manually.
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* Lightweight label serializer for minimal data transfer.
|
|
13
|
-
*
|
|
14
|
-
* Provides essential label information with visual properties,
|
|
15
|
-
* optimized for UI display and performance-critical operations.
|
|
16
|
-
* @export
|
|
17
|
-
* @interface LabelLite
|
|
18
|
-
*/
|
|
19
|
-
export interface LabelLite {
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @type {string}
|
|
23
|
-
* @memberof LabelLite
|
|
24
|
-
*/
|
|
25
|
-
readonly id?: string;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof LabelLite
|
|
30
|
-
*/
|
|
31
|
-
name: string;
|
|
32
|
-
/**
|
|
33
|
-
*
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof LabelLite
|
|
36
|
-
*/
|
|
37
|
-
color?: string;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Check if a given object implements the LabelLite interface.
|
|
41
|
-
*/
|
|
42
|
-
export declare function instanceOfLabelLite(value: object): value is LabelLite;
|
|
43
|
-
export declare function LabelLiteFromJSON(json: any): LabelLite;
|
|
44
|
-
export declare function LabelLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): LabelLite;
|
|
45
|
-
export declare function LabelLiteToJSON(json: any): LabelLite;
|
|
46
|
-
export declare function LabelLiteToJSONTyped(value?: Omit<LabelLite, 'id'> | null, ignoreDiscriminator?: boolean): any;
|
package/dist/models/LabelLite.js
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* The Plane REST API
|
|
6
|
-
* The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
|
|
7
|
-
*
|
|
8
|
-
* The version of the API Spec: 0.0.1
|
|
9
|
-
* Contact: support@plane.so
|
|
10
|
-
*
|
|
11
|
-
* NOTE: This class is auto generated.
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.instanceOfLabelLite = instanceOfLabelLite;
|
|
16
|
-
exports.LabelLiteFromJSON = LabelLiteFromJSON;
|
|
17
|
-
exports.LabelLiteFromJSONTyped = LabelLiteFromJSONTyped;
|
|
18
|
-
exports.LabelLiteToJSON = LabelLiteToJSON;
|
|
19
|
-
exports.LabelLiteToJSONTyped = LabelLiteToJSONTyped;
|
|
20
|
-
/**
|
|
21
|
-
* Check if a given object implements the LabelLite interface.
|
|
22
|
-
*/
|
|
23
|
-
function instanceOfLabelLite(value) {
|
|
24
|
-
if (!('name' in value) || value['name'] === undefined)
|
|
25
|
-
return false;
|
|
26
|
-
return true;
|
|
27
|
-
}
|
|
28
|
-
function LabelLiteFromJSON(json) {
|
|
29
|
-
return LabelLiteFromJSONTyped(json, false);
|
|
30
|
-
}
|
|
31
|
-
function LabelLiteFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
-
if (json == null) {
|
|
33
|
-
return json;
|
|
34
|
-
}
|
|
35
|
-
return {
|
|
36
|
-
'id': json['id'] == null ? undefined : json['id'],
|
|
37
|
-
'name': json['name'],
|
|
38
|
-
'color': json['color'] == null ? undefined : json['color'],
|
|
39
|
-
};
|
|
40
|
-
}
|
|
41
|
-
function LabelLiteToJSON(json) {
|
|
42
|
-
return LabelLiteToJSONTyped(json, false);
|
|
43
|
-
}
|
|
44
|
-
function LabelLiteToJSONTyped(value, ignoreDiscriminator) {
|
|
45
|
-
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
46
|
-
if (value == null) {
|
|
47
|
-
return value;
|
|
48
|
-
}
|
|
49
|
-
return {
|
|
50
|
-
'name': value['name'],
|
|
51
|
-
'color': value['color'],
|
|
52
|
-
};
|
|
53
|
-
}
|
package/src/models/LabelLite.ts
DELETED
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* The Plane REST API
|
|
5
|
-
* The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
|
|
6
|
-
*
|
|
7
|
-
* The version of the API Spec: 0.0.1
|
|
8
|
-
* Contact: support@plane.so
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated.
|
|
11
|
-
* Do not edit the class manually.
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
|
-
import { mapValues } from '../runtime';
|
|
15
|
-
/**
|
|
16
|
-
* Lightweight label serializer for minimal data transfer.
|
|
17
|
-
*
|
|
18
|
-
* Provides essential label information with visual properties,
|
|
19
|
-
* optimized for UI display and performance-critical operations.
|
|
20
|
-
* @export
|
|
21
|
-
* @interface LabelLite
|
|
22
|
-
*/
|
|
23
|
-
export interface LabelLite {
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof LabelLite
|
|
28
|
-
*/
|
|
29
|
-
readonly id?: string;
|
|
30
|
-
/**
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof LabelLite
|
|
34
|
-
*/
|
|
35
|
-
name: string;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof LabelLite
|
|
40
|
-
*/
|
|
41
|
-
color?: string;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* Check if a given object implements the LabelLite interface.
|
|
46
|
-
*/
|
|
47
|
-
export function instanceOfLabelLite(value: object): value is LabelLite {
|
|
48
|
-
if (!('name' in value) || value['name'] === undefined) return false;
|
|
49
|
-
return true;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
export function LabelLiteFromJSON(json: any): LabelLite {
|
|
53
|
-
return LabelLiteFromJSONTyped(json, false);
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
export function LabelLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): LabelLite {
|
|
57
|
-
if (json == null) {
|
|
58
|
-
return json;
|
|
59
|
-
}
|
|
60
|
-
return {
|
|
61
|
-
|
|
62
|
-
'id': json['id'] == null ? undefined : json['id'],
|
|
63
|
-
'name': json['name'],
|
|
64
|
-
'color': json['color'] == null ? undefined : json['color'],
|
|
65
|
-
};
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
export function LabelLiteToJSON(json: any): LabelLite {
|
|
69
|
-
return LabelLiteToJSONTyped(json, false);
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
export function LabelLiteToJSONTyped(value?: Omit<LabelLite, 'id'> | null, ignoreDiscriminator: boolean = false): any {
|
|
73
|
-
if (value == null) {
|
|
74
|
-
return value;
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
return {
|
|
78
|
-
|
|
79
|
-
'name': value['name'],
|
|
80
|
-
'color': value['color'],
|
|
81
|
-
};
|
|
82
|
-
}
|
|
83
|
-
|