@linear/sdk 2.5.0 → 3.0.0
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/CHANGELOG.md +118 -0
- package/dist/_generated_documents.d.ts +281 -23
- package/dist/_generated_documents.d.ts.map +1 -1
- package/dist/_generated_sdk.d.ts +131 -5
- package/dist/_generated_sdk.d.ts.map +1 -1
- package/dist/index-cjs.js +660 -21
- package/dist/index-cjs.js.map +1 -1
- package/dist/index-cjs.min.js +1 -1
- package/dist/index-cjs.min.js.br +0 -0
- package/dist/index-cjs.min.js.gz +0 -0
- package/dist/index-cjs.min.js.map +1 -1
- package/dist/index-es.js +655 -22
- package/dist/index-es.js.map +1 -1
- package/dist/index-es.min.js +1 -1
- package/dist/index-es.min.js.br +0 -0
- package/dist/index-es.min.js.gz +0 -0
- package/dist/index-es.min.js.map +1 -1
- package/dist/index-umd.js +661 -22
- package/dist/index-umd.js.map +1 -1
- package/dist/index-umd.min.js +1 -1
- package/dist/index-umd.min.js.br +0 -0
- package/dist/index-umd.min.js.gz +0 -0
- package/dist/index-umd.min.js.map +1 -1
- package/dist/webhooks.d.ts +1 -1
- package/dist/webhooks.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/_generated_sdk.d.ts
CHANGED
@@ -168,7 +168,7 @@ export declare class Attachment extends Request {
|
|
168
168
|
/** Information about the source which created the attachment. */
|
169
169
|
source?: Record<string, unknown>;
|
170
170
|
/** An accessor helper to source.type, defines the source type of the attachment. */
|
171
|
-
sourceType?:
|
171
|
+
sourceType?: string;
|
172
172
|
/** Content for the subtitle line in the Linear attachment widget. */
|
173
173
|
subtitle?: string;
|
174
174
|
/** Content for the title line in the Linear attachment widget. */
|
@@ -486,6 +486,21 @@ export declare class CustomViewPayload extends Request {
|
|
486
486
|
/** The custom view that was created or updated. */
|
487
487
|
get customView(): LinearFetch<CustomView> | undefined;
|
488
488
|
}
|
489
|
+
/**
|
490
|
+
* CustomViewSuggestionPayload model
|
491
|
+
*
|
492
|
+
* @param request - function to call the graphql client
|
493
|
+
* @param data - L.CustomViewSuggestionPayloadFragment response data
|
494
|
+
*/
|
495
|
+
export declare class CustomViewSuggestionPayload extends Request {
|
496
|
+
constructor(request: LinearRequest, data: L.CustomViewSuggestionPayloadFragment);
|
497
|
+
/** The suggested view description. */
|
498
|
+
suggestedDescription?: string;
|
499
|
+
/** The suggested view icon. */
|
500
|
+
suggestedIcon?: string;
|
501
|
+
/** The suggested view name. */
|
502
|
+
suggestedName?: string;
|
503
|
+
}
|
489
504
|
/**
|
490
505
|
* A set of issues to be resolved in a specified amount of time.
|
491
506
|
*
|
@@ -1281,6 +1296,7 @@ export declare class Issue extends Request {
|
|
1281
1296
|
private _cycle?;
|
1282
1297
|
private _parent?;
|
1283
1298
|
private _project?;
|
1299
|
+
private _projectMilestone?;
|
1284
1300
|
private _snoozedBy?;
|
1285
1301
|
private _state;
|
1286
1302
|
private _team;
|
@@ -1317,7 +1333,7 @@ export declare class Issue extends Request {
|
|
1317
1333
|
number: number;
|
1318
1334
|
/** Previous identifiers of the issue if it has been moved between teams. */
|
1319
1335
|
previousIdentifiers: string[];
|
1320
|
-
/** The priority of the issue. */
|
1336
|
+
/** The priority of the issue. 0 = No priority, 1 = Urgent, 2 = High, 3 = Normal, 4 = Low. */
|
1321
1337
|
priority: number;
|
1322
1338
|
/** Label for the priority. */
|
1323
1339
|
priorityLabel: string;
|
@@ -1355,6 +1371,8 @@ export declare class Issue extends Request {
|
|
1355
1371
|
get parent(): LinearFetch<Issue> | undefined;
|
1356
1372
|
/** The project that the issue is associated with. */
|
1357
1373
|
get project(): LinearFetch<Project> | undefined;
|
1374
|
+
/** The projectMilestone that the issue is associated with. */
|
1375
|
+
get projectMilestone(): LinearFetch<ProjectMilestone> | undefined;
|
1358
1376
|
/** The user who snoozed the issue. */
|
1359
1377
|
get snoozedBy(): LinearFetch<User> | undefined;
|
1360
1378
|
/** The workflow state that the issue is associated with. */
|
@@ -2237,6 +2255,8 @@ export declare class Organization extends Request {
|
|
2237
2255
|
samlEnabled: boolean;
|
2238
2256
|
/** Whether SCIM provisioning is enabled for organization. */
|
2239
2257
|
scimEnabled: boolean;
|
2258
|
+
/** The time at which the trial of the plus plan will end. */
|
2259
|
+
trialEndsAt?: Date;
|
2240
2260
|
/**
|
2241
2261
|
* The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
|
2242
2262
|
* for which updates should not produce an update to updatedAt (see skipUpdatedAtKeys). This is the same as the creation time if the entity hasn't
|
@@ -2442,6 +2462,17 @@ export declare class OrganizationPayload extends Request {
|
|
2442
2462
|
/** The organization that was created or updated. */
|
2443
2463
|
get organization(): LinearFetch<Organization>;
|
2444
2464
|
}
|
2465
|
+
/**
|
2466
|
+
* OrganizationStartPlusTrialPayload model
|
2467
|
+
*
|
2468
|
+
* @param request - function to call the graphql client
|
2469
|
+
* @param data - L.OrganizationStartPlusTrialPayloadFragment response data
|
2470
|
+
*/
|
2471
|
+
export declare class OrganizationStartPlusTrialPayload extends Request {
|
2472
|
+
constructor(request: LinearRequest, data: L.OrganizationStartPlusTrialPayloadFragment);
|
2473
|
+
/** Whether the operation was successful. */
|
2474
|
+
success: boolean;
|
2475
|
+
}
|
2445
2476
|
/**
|
2446
2477
|
* PageInfo model
|
2447
2478
|
*
|
@@ -2581,7 +2612,7 @@ export declare class Project extends Request {
|
|
2581
2612
|
slackNewIssue: boolean;
|
2582
2613
|
/** The project's unique URL slug. */
|
2583
2614
|
slugId: string;
|
2584
|
-
/** The sort order for the project within the
|
2615
|
+
/** The sort order for the project within the organization. */
|
2585
2616
|
sortOrder: number;
|
2586
2617
|
/** The time at which the project was moved into started state. */
|
2587
2618
|
startedAt?: Date;
|
@@ -2613,6 +2644,8 @@ export declare class Project extends Request {
|
|
2613
2644
|
links(variables?: Omit<L.Project_LinksQueryVariables, "id">): LinearFetch<ProjectLinkConnection>;
|
2614
2645
|
/** Users that are members of the project. */
|
2615
2646
|
members(variables?: Omit<L.Project_MembersQueryVariables, "id">): LinearFetch<UserConnection>;
|
2647
|
+
/** Milestones associated with the project. */
|
2648
|
+
projectMilestones(variables?: Omit<L.Project_ProjectMilestonesQueryVariables, "id">): LinearFetch<ProjectMilestoneConnection>;
|
2616
2649
|
/** Project updates associated with the project. */
|
2617
2650
|
projectUpdates(variables?: Omit<L.Project_ProjectUpdatesQueryVariables, "id">): LinearFetch<ProjectUpdateConnection>;
|
2618
2651
|
/** Teams associated with this project. */
|
@@ -3102,7 +3135,7 @@ export declare class RateLimitResultPayload extends Request {
|
|
3102
3135
|
* @param data - L.ReactionFragment response data
|
3103
3136
|
*/
|
3104
3137
|
export declare class Reaction extends Request {
|
3105
|
-
private _user
|
3138
|
+
private _user?;
|
3106
3139
|
constructor(request: LinearRequest, data: L.ReactionFragment);
|
3107
3140
|
/** The time at which the entity was archived. Null if the entity has not been archived. */
|
3108
3141
|
archivedAt?: Date;
|
@@ -3160,6 +3193,8 @@ export declare class Roadmap extends Request {
|
|
3160
3193
|
constructor(request: LinearRequest, data: L.RoadmapFragment);
|
3161
3194
|
/** The time at which the entity was archived. Null if the entity has not been archived. */
|
3162
3195
|
archivedAt?: Date;
|
3196
|
+
/** The roadmap's color. */
|
3197
|
+
color?: string;
|
3163
3198
|
/** The time at which the entity was created. */
|
3164
3199
|
createdAt: Date;
|
3165
3200
|
/** The description of the roadmap. */
|
@@ -3170,6 +3205,8 @@ export declare class Roadmap extends Request {
|
|
3170
3205
|
name: string;
|
3171
3206
|
/** The roadmap's unique URL slug. */
|
3172
3207
|
slugId: string;
|
3208
|
+
/** The sort order of the roadmap within the organization. */
|
3209
|
+
sortOrder: number;
|
3173
3210
|
/**
|
3174
3211
|
* The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
|
3175
3212
|
* for which updates should not produce an update to updatedAt (see skipUpdatedAtKeys). This is the same as the creation time if the entity hasn't
|
@@ -3184,10 +3221,14 @@ export declare class Roadmap extends Request {
|
|
3184
3221
|
get owner(): LinearFetch<User> | undefined;
|
3185
3222
|
/** Projects associated with the roadmap. */
|
3186
3223
|
projects(variables?: Omit<L.Roadmap_ProjectsQueryVariables, "id">): LinearFetch<ProjectConnection>;
|
3224
|
+
/** Archives a roadmap. */
|
3225
|
+
archive(): LinearFetch<ArchivePayload>;
|
3187
3226
|
/** Creates a new roadmap. */
|
3188
3227
|
create(input: L.RoadmapCreateInput): LinearFetch<RoadmapPayload>;
|
3189
3228
|
/** Deletes a roadmap. */
|
3190
3229
|
delete(): LinearFetch<ArchivePayload>;
|
3230
|
+
/** Unarchives a roadmap. */
|
3231
|
+
unarchive(): LinearFetch<ArchivePayload>;
|
3191
3232
|
/** Updates a roadmap. */
|
3192
3233
|
update(input: L.RoadmapUpdateInput): LinearFetch<RoadmapPayload>;
|
3193
3234
|
}
|
@@ -3794,7 +3835,7 @@ export declare class User extends Request {
|
|
3794
3835
|
archivedAt?: Date;
|
3795
3836
|
/** An URL to the user's avatar image. */
|
3796
3837
|
avatarUrl?: string;
|
3797
|
-
/** Hash for the user to be used in calendar URLs. */
|
3838
|
+
/** [DEPRECATED] Hash for the user to be used in calendar URLs. */
|
3798
3839
|
calendarHash?: string;
|
3799
3840
|
/** The time at which the entity was created. */
|
3800
3841
|
createdAt: Date;
|
@@ -3957,6 +3998,8 @@ export declare class UserSettings extends Request {
|
|
3957
3998
|
constructor(request: LinearRequest, data: L.UserSettingsFragment);
|
3958
3999
|
/** The time at which the entity was archived. Null if the entity has not been archived. */
|
3959
4000
|
archivedAt?: Date;
|
4001
|
+
/** Hash for the user to be used in calendar URLs. */
|
4002
|
+
calendarHash?: string;
|
3960
4003
|
/** The time at which the entity was created. */
|
3961
4004
|
createdAt: Date;
|
3962
4005
|
/** The unique identifier of the entity. */
|
@@ -5934,6 +5977,20 @@ export declare class UpdateOrganizationInviteMutation extends Request {
|
|
5934
5977
|
*/
|
5935
5978
|
fetch(id: string, input: L.OrganizationInviteUpdateInput): LinearFetch<OrganizationInvitePayload>;
|
5936
5979
|
}
|
5980
|
+
/**
|
5981
|
+
* A fetchable OrganizationStartPlusTrial Mutation
|
5982
|
+
*
|
5983
|
+
* @param request - function to call the graphql client
|
5984
|
+
*/
|
5985
|
+
export declare class OrganizationStartPlusTrialMutation extends Request {
|
5986
|
+
constructor(request: LinearRequest);
|
5987
|
+
/**
|
5988
|
+
* Call the OrganizationStartPlusTrial mutation and return a OrganizationStartPlusTrialPayload
|
5989
|
+
*
|
5990
|
+
* @returns parsed response from OrganizationStartPlusTrialMutation
|
5991
|
+
*/
|
5992
|
+
fetch(): LinearFetch<OrganizationStartPlusTrialPayload>;
|
5993
|
+
}
|
5937
5994
|
/**
|
5938
5995
|
* A fetchable UpdateOrganization Mutation
|
5939
5996
|
*
|
@@ -6283,6 +6340,21 @@ export declare class ResendOrganizationInviteMutation extends Request {
|
|
6283
6340
|
*/
|
6284
6341
|
fetch(id: string): LinearFetch<ArchivePayload>;
|
6285
6342
|
}
|
6343
|
+
/**
|
6344
|
+
* A fetchable ArchiveRoadmap Mutation
|
6345
|
+
*
|
6346
|
+
* @param request - function to call the graphql client
|
6347
|
+
*/
|
6348
|
+
export declare class ArchiveRoadmapMutation extends Request {
|
6349
|
+
constructor(request: LinearRequest);
|
6350
|
+
/**
|
6351
|
+
* Call the ArchiveRoadmap mutation and return a ArchivePayload
|
6352
|
+
*
|
6353
|
+
* @param id - required id to pass to archiveRoadmap
|
6354
|
+
* @returns parsed response from ArchiveRoadmapMutation
|
6355
|
+
*/
|
6356
|
+
fetch(id: string): LinearFetch<ArchivePayload>;
|
6357
|
+
}
|
6286
6358
|
/**
|
6287
6359
|
* A fetchable CreateRoadmap Mutation
|
6288
6360
|
*
|
@@ -6359,6 +6431,21 @@ export declare class UpdateRoadmapToProjectMutation extends Request {
|
|
6359
6431
|
*/
|
6360
6432
|
fetch(id: string, input: L.RoadmapToProjectUpdateInput): LinearFetch<RoadmapToProjectPayload>;
|
6361
6433
|
}
|
6434
|
+
/**
|
6435
|
+
* A fetchable UnarchiveRoadmap Mutation
|
6436
|
+
*
|
6437
|
+
* @param request - function to call the graphql client
|
6438
|
+
*/
|
6439
|
+
export declare class UnarchiveRoadmapMutation extends Request {
|
6440
|
+
constructor(request: LinearRequest);
|
6441
|
+
/**
|
6442
|
+
* Call the UnarchiveRoadmap mutation and return a ArchivePayload
|
6443
|
+
*
|
6444
|
+
* @param id - required id to pass to unarchiveRoadmap
|
6445
|
+
* @returns parsed response from UnarchiveRoadmapMutation
|
6446
|
+
*/
|
6447
|
+
fetch(id: string): LinearFetch<ArchivePayload>;
|
6448
|
+
}
|
6362
6449
|
/**
|
6363
6450
|
* A fetchable UpdateRoadmap Mutation
|
6364
6451
|
*
|
@@ -8856,6 +8943,25 @@ export declare class Project_MembersQuery extends Request {
|
|
8856
8943
|
*/
|
8857
8944
|
fetch(variables?: Omit<L.Project_MembersQueryVariables, "id">): LinearFetch<UserConnection>;
|
8858
8945
|
}
|
8946
|
+
/**
|
8947
|
+
* A fetchable Project_ProjectMilestones Query
|
8948
|
+
*
|
8949
|
+
* @param request - function to call the graphql client
|
8950
|
+
* @param id - required id to pass to project
|
8951
|
+
* @param variables - variables without 'id' to pass into the Project_ProjectMilestonesQuery
|
8952
|
+
*/
|
8953
|
+
export declare class Project_ProjectMilestonesQuery extends Request {
|
8954
|
+
private _id;
|
8955
|
+
private _variables?;
|
8956
|
+
constructor(request: LinearRequest, id: string, variables?: Omit<L.Project_ProjectMilestonesQueryVariables, "id">);
|
8957
|
+
/**
|
8958
|
+
* Call the Project_ProjectMilestones query and return a ProjectMilestoneConnection
|
8959
|
+
*
|
8960
|
+
* @param variables - variables without 'id' to pass into the Project_ProjectMilestonesQuery
|
8961
|
+
* @returns parsed response from Project_ProjectMilestonesQuery
|
8962
|
+
*/
|
8963
|
+
fetch(variables?: Omit<L.Project_ProjectMilestonesQueryVariables, "id">): LinearFetch<ProjectMilestoneConnection>;
|
8964
|
+
}
|
8859
8965
|
/**
|
8860
8966
|
* A fetchable Project_ProjectUpdates Query
|
8861
8967
|
*
|
@@ -10035,6 +10141,12 @@ export declare class LinearSdk extends Request {
|
|
10035
10141
|
* @returns OrganizationInvitePayload
|
10036
10142
|
*/
|
10037
10143
|
updateOrganizationInvite(id: string, input: L.OrganizationInviteUpdateInput): LinearFetch<OrganizationInvitePayload>;
|
10144
|
+
/**
|
10145
|
+
* Starts a plus trial for the organization. Administrator privileges required.
|
10146
|
+
*
|
10147
|
+
* @returns OrganizationStartPlusTrialPayload
|
10148
|
+
*/
|
10149
|
+
get organizationStartPlusTrial(): LinearFetch<OrganizationStartPlusTrialPayload>;
|
10038
10150
|
/**
|
10039
10151
|
* Updates the user's organization.
|
10040
10152
|
*
|
@@ -10200,6 +10312,13 @@ export declare class LinearSdk extends Request {
|
|
10200
10312
|
* @returns ArchivePayload
|
10201
10313
|
*/
|
10202
10314
|
resendOrganizationInvite(id: string): LinearFetch<ArchivePayload>;
|
10315
|
+
/**
|
10316
|
+
* Archives a roadmap.
|
10317
|
+
*
|
10318
|
+
* @param id - required id to pass to archiveRoadmap
|
10319
|
+
* @returns ArchivePayload
|
10320
|
+
*/
|
10321
|
+
archiveRoadmap(id: string): LinearFetch<ArchivePayload>;
|
10203
10322
|
/**
|
10204
10323
|
* Creates a new roadmap.
|
10205
10324
|
*
|
@@ -10236,6 +10355,13 @@ export declare class LinearSdk extends Request {
|
|
10236
10355
|
* @returns RoadmapToProjectPayload
|
10237
10356
|
*/
|
10238
10357
|
updateRoadmapToProject(id: string, input: L.RoadmapToProjectUpdateInput): LinearFetch<RoadmapToProjectPayload>;
|
10358
|
+
/**
|
10359
|
+
* Unarchives a roadmap.
|
10360
|
+
*
|
10361
|
+
* @param id - required id to pass to unarchiveRoadmap
|
10362
|
+
* @returns ArchivePayload
|
10363
|
+
*/
|
10364
|
+
unarchiveRoadmap(id: string): LinearFetch<ArchivePayload>;
|
10239
10365
|
/**
|
10240
10366
|
* Updates a roadmap.
|
10241
10367
|
*
|