@useshortcut/client 2.2.0 → 2.3.1
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/lib/ShortcutClient.d.mts +13 -1
- package/lib/ShortcutClient.d.ts +13 -1
- package/lib/ShortcutClient.js +19 -0
- package/lib/ShortcutClient.mjs +19 -0
- package/lib/generated/Api.d.mts +135 -135
- package/lib/generated/Api.d.ts +135 -135
- package/lib/generated/Api.js +3 -3
- package/lib/generated/Api.mjs +3 -3
- package/lib/generated/data-contracts.d.mts +38 -0
- package/lib/generated/data-contracts.d.ts +38 -0
- package/package.json +2 -2
package/lib/generated/Api.js
CHANGED
|
@@ -1712,12 +1712,12 @@ var Api = class extends require_http_client.HttpClient {
|
|
|
1712
1712
|
/**
|
|
1713
1713
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1714
1714
|
*
|
|
1715
|
-
* @name
|
|
1716
|
-
* @summary
|
|
1715
|
+
* @name QueryStories
|
|
1716
|
+
* @summary Query Stories
|
|
1717
1717
|
* @request POST:/api/v3/stories/search
|
|
1718
1718
|
* @secure
|
|
1719
1719
|
*/
|
|
1720
|
-
|
|
1720
|
+
queryStories = (SearchStories, params = {}) => this.request({
|
|
1721
1721
|
path: `/api/v3/stories/search`,
|
|
1722
1722
|
method: "POST",
|
|
1723
1723
|
body: SearchStories,
|
package/lib/generated/Api.mjs
CHANGED
|
@@ -1712,12 +1712,12 @@ var Api = class extends HttpClient {
|
|
|
1712
1712
|
/**
|
|
1713
1713
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1714
1714
|
*
|
|
1715
|
-
* @name
|
|
1716
|
-
* @summary
|
|
1715
|
+
* @name QueryStories
|
|
1716
|
+
* @summary Query Stories
|
|
1717
1717
|
* @request POST:/api/v3/stories/search
|
|
1718
1718
|
* @secure
|
|
1719
1719
|
*/
|
|
1720
|
-
|
|
1720
|
+
queryStories = (SearchStories, params = {}) => this.request({
|
|
1721
1721
|
path: `/api/v3/stories/search`,
|
|
1722
1722
|
method: "POST",
|
|
1723
1723
|
body: SearchStories,
|
|
@@ -28,6 +28,7 @@ interface BasicWorkspaceInfo {
|
|
|
28
28
|
name: string;
|
|
29
29
|
url_slug: string;
|
|
30
30
|
utc_offset: string;
|
|
31
|
+
korey_enabled?: boolean;
|
|
31
32
|
}
|
|
32
33
|
/** Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories. */
|
|
33
34
|
interface Branch {
|
|
@@ -2001,6 +2002,11 @@ interface Group {
|
|
|
2001
2002
|
* @format int64
|
|
2002
2003
|
*/
|
|
2003
2004
|
num_epics_started: number;
|
|
2005
|
+
/**
|
|
2006
|
+
* The last instant when this group was updated.
|
|
2007
|
+
* @format date-time
|
|
2008
|
+
*/
|
|
2009
|
+
updated_at: string;
|
|
2004
2010
|
/**
|
|
2005
2011
|
* The number of stories assigned to the group which are in a backlog workflow state.
|
|
2006
2012
|
* @format int64
|
|
@@ -2022,6 +2028,11 @@ interface Group {
|
|
|
2022
2028
|
member_ids: string[];
|
|
2023
2029
|
/** The Workflow IDs contained within the Group. */
|
|
2024
2030
|
workflow_ids: number[];
|
|
2031
|
+
/**
|
|
2032
|
+
* The instant when this group was created.
|
|
2033
|
+
* @format date-time
|
|
2034
|
+
*/
|
|
2035
|
+
created_at: string;
|
|
2025
2036
|
}
|
|
2026
2037
|
/** The current health status of the Epic. */
|
|
2027
2038
|
interface Health {
|
|
@@ -2322,6 +2333,11 @@ interface HistoryActionStoryCreate {
|
|
|
2322
2333
|
* @format int64
|
|
2323
2334
|
*/
|
|
2324
2335
|
id: number;
|
|
2336
|
+
/**
|
|
2337
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2338
|
+
* @format int64
|
|
2339
|
+
*/
|
|
2340
|
+
parent_story_id?: number;
|
|
2325
2341
|
/**
|
|
2326
2342
|
* The estimate (or point value) for the Story.
|
|
2327
2343
|
* @format int64
|
|
@@ -2356,6 +2372,11 @@ interface HistoryActionStoryDelete {
|
|
|
2356
2372
|
name: string;
|
|
2357
2373
|
/** The type of Story; either feature, bug, or chore. */
|
|
2358
2374
|
story_type: "feature" | "chore" | "bug";
|
|
2375
|
+
/**
|
|
2376
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2377
|
+
* @format int64
|
|
2378
|
+
*/
|
|
2379
|
+
parent_story_id?: number;
|
|
2359
2380
|
}
|
|
2360
2381
|
/** An action representing a Story Link being created. */
|
|
2361
2382
|
interface HistoryActionStoryLinkCreate {
|
|
@@ -2454,6 +2475,11 @@ interface HistoryActionStoryUpdate {
|
|
|
2454
2475
|
name: string;
|
|
2455
2476
|
/** The type of Story; either feature, bug, or chore. */
|
|
2456
2477
|
story_type: "feature" | "chore" | "bug";
|
|
2478
|
+
/**
|
|
2479
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2480
|
+
* @format int64
|
|
2481
|
+
*/
|
|
2482
|
+
parent_story_id?: number;
|
|
2457
2483
|
}
|
|
2458
2484
|
/** An action representing a Task being created. */
|
|
2459
2485
|
interface HistoryActionTaskCreate {
|
|
@@ -2575,6 +2601,8 @@ interface HistoryChangesStory {
|
|
|
2575
2601
|
/** Custom Field Enum Value IDs that have been added or removed from the Story. */
|
|
2576
2602
|
custom_field_value_ids?: StoryHistoryChangeAddsRemovesUuid;
|
|
2577
2603
|
/** The estimate value for the Story */
|
|
2604
|
+
parent_story_id?: StoryHistoryChangeOldNewInt;
|
|
2605
|
+
/** The estimate value for the Story */
|
|
2578
2606
|
estimate?: StoryHistoryChangeOldNewInt;
|
|
2579
2607
|
/** Task IDs that have been added or removed from the Story. */
|
|
2580
2608
|
subject_story_link_ids?: StoryHistoryChangeAddsRemovesInt;
|
|
@@ -2754,6 +2782,11 @@ interface HistoryReferenceStory {
|
|
|
2754
2782
|
name: string;
|
|
2755
2783
|
/** If the referenced entity is a Story, either "bug", "chore", or "feature". */
|
|
2756
2784
|
story_type: "feature" | "chore" | "bug";
|
|
2785
|
+
/**
|
|
2786
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2787
|
+
* @format int64
|
|
2788
|
+
*/
|
|
2789
|
+
parent_story_id?: number;
|
|
2757
2790
|
}
|
|
2758
2791
|
/** A reference to a Story Task. */
|
|
2759
2792
|
interface HistoryReferenceStoryTask {
|
|
@@ -3304,6 +3337,11 @@ interface Member {
|
|
|
3304
3337
|
* @format uuid
|
|
3305
3338
|
*/
|
|
3306
3339
|
id: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* Only set for agents. The installation id associated with this agent.
|
|
3342
|
+
* @format uuid
|
|
3343
|
+
*/
|
|
3344
|
+
installation_id?: string;
|
|
3307
3345
|
/** A group of Member profile details. */
|
|
3308
3346
|
profile: Profile;
|
|
3309
3347
|
/**
|
|
@@ -28,6 +28,7 @@ interface BasicWorkspaceInfo {
|
|
|
28
28
|
name: string;
|
|
29
29
|
url_slug: string;
|
|
30
30
|
utc_offset: string;
|
|
31
|
+
korey_enabled?: boolean;
|
|
31
32
|
}
|
|
32
33
|
/** Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories. */
|
|
33
34
|
interface Branch {
|
|
@@ -2001,6 +2002,11 @@ interface Group {
|
|
|
2001
2002
|
* @format int64
|
|
2002
2003
|
*/
|
|
2003
2004
|
num_epics_started: number;
|
|
2005
|
+
/**
|
|
2006
|
+
* The last instant when this group was updated.
|
|
2007
|
+
* @format date-time
|
|
2008
|
+
*/
|
|
2009
|
+
updated_at: string;
|
|
2004
2010
|
/**
|
|
2005
2011
|
* The number of stories assigned to the group which are in a backlog workflow state.
|
|
2006
2012
|
* @format int64
|
|
@@ -2022,6 +2028,11 @@ interface Group {
|
|
|
2022
2028
|
member_ids: string[];
|
|
2023
2029
|
/** The Workflow IDs contained within the Group. */
|
|
2024
2030
|
workflow_ids: number[];
|
|
2031
|
+
/**
|
|
2032
|
+
* The instant when this group was created.
|
|
2033
|
+
* @format date-time
|
|
2034
|
+
*/
|
|
2035
|
+
created_at: string;
|
|
2025
2036
|
}
|
|
2026
2037
|
/** The current health status of the Epic. */
|
|
2027
2038
|
interface Health {
|
|
@@ -2322,6 +2333,11 @@ interface HistoryActionStoryCreate {
|
|
|
2322
2333
|
* @format int64
|
|
2323
2334
|
*/
|
|
2324
2335
|
id: number;
|
|
2336
|
+
/**
|
|
2337
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2338
|
+
* @format int64
|
|
2339
|
+
*/
|
|
2340
|
+
parent_story_id?: number;
|
|
2325
2341
|
/**
|
|
2326
2342
|
* The estimate (or point value) for the Story.
|
|
2327
2343
|
* @format int64
|
|
@@ -2356,6 +2372,11 @@ interface HistoryActionStoryDelete {
|
|
|
2356
2372
|
name: string;
|
|
2357
2373
|
/** The type of Story; either feature, bug, or chore. */
|
|
2358
2374
|
story_type: "feature" | "chore" | "bug";
|
|
2375
|
+
/**
|
|
2376
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2377
|
+
* @format int64
|
|
2378
|
+
*/
|
|
2379
|
+
parent_story_id?: number;
|
|
2359
2380
|
}
|
|
2360
2381
|
/** An action representing a Story Link being created. */
|
|
2361
2382
|
interface HistoryActionStoryLinkCreate {
|
|
@@ -2454,6 +2475,11 @@ interface HistoryActionStoryUpdate {
|
|
|
2454
2475
|
name: string;
|
|
2455
2476
|
/** The type of Story; either feature, bug, or chore. */
|
|
2456
2477
|
story_type: "feature" | "chore" | "bug";
|
|
2478
|
+
/**
|
|
2479
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2480
|
+
* @format int64
|
|
2481
|
+
*/
|
|
2482
|
+
parent_story_id?: number;
|
|
2457
2483
|
}
|
|
2458
2484
|
/** An action representing a Task being created. */
|
|
2459
2485
|
interface HistoryActionTaskCreate {
|
|
@@ -2575,6 +2601,8 @@ interface HistoryChangesStory {
|
|
|
2575
2601
|
/** Custom Field Enum Value IDs that have been added or removed from the Story. */
|
|
2576
2602
|
custom_field_value_ids?: StoryHistoryChangeAddsRemovesUuid;
|
|
2577
2603
|
/** The estimate value for the Story */
|
|
2604
|
+
parent_story_id?: StoryHistoryChangeOldNewInt;
|
|
2605
|
+
/** The estimate value for the Story */
|
|
2578
2606
|
estimate?: StoryHistoryChangeOldNewInt;
|
|
2579
2607
|
/** Task IDs that have been added or removed from the Story. */
|
|
2580
2608
|
subject_story_link_ids?: StoryHistoryChangeAddsRemovesInt;
|
|
@@ -2754,6 +2782,11 @@ interface HistoryReferenceStory {
|
|
|
2754
2782
|
name: string;
|
|
2755
2783
|
/** If the referenced entity is a Story, either "bug", "chore", or "feature". */
|
|
2756
2784
|
story_type: "feature" | "chore" | "bug";
|
|
2785
|
+
/**
|
|
2786
|
+
* The Story's Parent ID (only applicable if Story is a Sub-task)
|
|
2787
|
+
* @format int64
|
|
2788
|
+
*/
|
|
2789
|
+
parent_story_id?: number;
|
|
2757
2790
|
}
|
|
2758
2791
|
/** A reference to a Story Task. */
|
|
2759
2792
|
interface HistoryReferenceStoryTask {
|
|
@@ -3304,6 +3337,11 @@ interface Member {
|
|
|
3304
3337
|
* @format uuid
|
|
3305
3338
|
*/
|
|
3306
3339
|
id: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* Only set for agents. The installation id associated with this agent.
|
|
3342
|
+
* @format uuid
|
|
3343
|
+
*/
|
|
3344
|
+
installation_id?: string;
|
|
3307
3345
|
/** A group of Member profile details. */
|
|
3308
3346
|
profile: Profile;
|
|
3309
3347
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@useshortcut/client",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.1",
|
|
4
4
|
"description": "A library for interacting with the Shortcut REST API",
|
|
5
5
|
"homepage": "https://github.com/useshortcut/shortcut-client-js",
|
|
6
6
|
"bugs": {
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"lib"
|
|
27
27
|
],
|
|
28
28
|
"scripts": {
|
|
29
|
-
"build": "yarn build:client && yarn build:add-typedoc-comments && tsdown",
|
|
29
|
+
"build": "yarn build:client && yarn build:add-typedoc-comments && NODE_OPTIONS=\"--no-experimental-strip-types\" tsdown",
|
|
30
30
|
"build:add-typedoc-comments": "npx jscodeshift -t scripts/add-typedoc-comments.ts --extensions=ts --parser=ts src/generated/**",
|
|
31
31
|
"build:client": "swagger-typescript-api generate --path ./schema/shortcut.swagger.json --output ./src/generated --clean-output --axios --modular --templates ./templates",
|
|
32
32
|
"build:docs": "typedoc ./src --exclude 'src/__tests__/**'",
|