@linear/sdk 17.0.1 → 18.1.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.
@@ -391,6 +391,25 @@ export declare class AuthApiKeyPayload extends Request {
391
391
  /** The auth API key that was created. */
392
392
  authApiKey: AuthApiKey;
393
393
  }
394
+ /**
395
+ * An email address that can be used for submitting issues.
396
+ *
397
+ * @param request - function to call the graphql client
398
+ * @param data - L.AuthEmailIntakeAddressFragment response data
399
+ */
400
+ export declare class AuthEmailIntakeAddress extends Request {
401
+ constructor(request: LinearRequest, data: L.AuthEmailIntakeAddressFragment);
402
+ /** Unique email address user name (before @) used for incoming email. */
403
+ address: string;
404
+ /** Whether the email address is enabled. */
405
+ enabled: boolean;
406
+ /** The unique identifier of the entity. */
407
+ id: string;
408
+ /** The auth user who created the email intake address. */
409
+ creator?: AuthUser;
410
+ /** The auth organization that the email address is associated with. */
411
+ organization: AuthOrganization;
412
+ }
394
413
  /**
395
414
  * AuthIntegration model
396
415
  *
@@ -515,6 +534,8 @@ export declare class AuthOrganization extends Request {
515
534
  name: string;
516
535
  /** Previously used URL keys for the organization (last 3 are kept and redirected). */
517
536
  previousUrlKeys: string[];
537
+ /** The region the organization is hosted in. */
538
+ region: string;
518
539
  /** Whether SAML authentication is enabled for organization. */
519
540
  samlEnabled: boolean;
520
541
  /** Whether SCIM provisioning is enabled for organization. */
@@ -1223,6 +1244,8 @@ export declare class Document extends Request {
1223
1244
  content?: string;
1224
1245
  /** The time at which the entity was created. */
1225
1246
  createdAt: Date;
1247
+ /** The time at which the document was hidden. Null if the entity has not been hidden. */
1248
+ hiddenAt?: Date;
1226
1249
  /** The icon of the document. */
1227
1250
  icon?: string;
1228
1251
  /** The unique identifier of the entity. */
@@ -1411,6 +1434,8 @@ export declare class DocumentSearchResult extends Request {
1411
1434
  content?: string;
1412
1435
  /** The time at which the entity was created. */
1413
1436
  createdAt: Date;
1437
+ /** The time at which the document was hidden. Null if the entity has not been hidden. */
1438
+ hiddenAt?: Date;
1414
1439
  /** The icon of the document. */
1415
1440
  icon?: string;
1416
1441
  /** The unique identifier of the entity. */
@@ -2339,6 +2364,7 @@ export declare class Issue extends Request {
2339
2364
  private _project?;
2340
2365
  private _projectMilestone?;
2341
2366
  private _snoozedBy?;
2367
+ private _sourceComment?;
2342
2368
  private _state;
2343
2369
  private _team;
2344
2370
  constructor(request: LinearRequest, data: L.IssueFragment);
@@ -2426,6 +2452,8 @@ export declare class Issue extends Request {
2426
2452
  get projectMilestone(): LinearFetch<ProjectMilestone> | undefined;
2427
2453
  /** The user who snoozed the issue. */
2428
2454
  get snoozedBy(): LinearFetch<User> | undefined;
2455
+ /** The comment that this issue was created from. */
2456
+ get sourceComment(): LinearFetch<Comment> | undefined;
2429
2457
  /** The workflow state that the issue is associated with. */
2430
2458
  get state(): LinearFetch<WorkflowState> | undefined;
2431
2459
  /** The team that the issue is associated with. */
@@ -3008,6 +3036,7 @@ export declare class IssueSearchResult extends Request {
3008
3036
  private _project?;
3009
3037
  private _projectMilestone?;
3010
3038
  private _snoozedBy?;
3039
+ private _sourceComment?;
3011
3040
  private _state;
3012
3041
  private _team;
3013
3042
  constructor(request: LinearRequest, data: L.IssueSearchResultFragment);
@@ -3097,6 +3126,8 @@ export declare class IssueSearchResult extends Request {
3097
3126
  get projectMilestone(): LinearFetch<ProjectMilestone> | undefined;
3098
3127
  /** The user who snoozed the issue. */
3099
3128
  get snoozedBy(): LinearFetch<User> | undefined;
3129
+ /** The comment that this issue was created from. */
3130
+ get sourceComment(): LinearFetch<Comment> | undefined;
3100
3131
  /** The workflow state that the issue is associated with. */
3101
3132
  get state(): LinearFetch<WorkflowState> | undefined;
3102
3133
  /** The team that the issue is associated with. */
@@ -3805,6 +3836,8 @@ export declare class OrganizationInviteFullDetailsPayload extends Request {
3805
3836
  constructor(request: LinearRequest, data: L.OrganizationInviteFullDetailsPayloadFragment);
3806
3837
  /** Whether the invite has already been accepted. */
3807
3838
  accepted: boolean;
3839
+ /** Allowed authentication providers, empty array means all are allowed. */
3840
+ allowedAuthServices: string[];
3808
3841
  /** When the invite was created. */
3809
3842
  createdAt: Date;
3810
3843
  /** The email of the invitee. */
@@ -3820,6 +3853,27 @@ export declare class OrganizationInviteFullDetailsPayload extends Request {
3820
3853
  /** Name of the workspace the invite is for. */
3821
3854
  organizationName: string;
3822
3855
  }
3856
+ /**
3857
+ * OrganizationInviteLinkDetailsPayload model
3858
+ *
3859
+ * @param request - function to call the graphql client
3860
+ * @param data - L.OrganizationInviteLinkDetailsPayloadFragment response data
3861
+ */
3862
+ export declare class OrganizationInviteLinkDetailsPayload extends Request {
3863
+ constructor(request: LinearRequest, data: L.OrganizationInviteLinkDetailsPayloadFragment);
3864
+ /** Allowed authentication providers, empty array means all are allowed. */
3865
+ allowedAuthServices: string[];
3866
+ /** ID of the workspace the invite link is for. */
3867
+ organizationId?: string;
3868
+ /** URL of the workspace logo the invite link is for. */
3869
+ organizationLogoUrl?: string;
3870
+ /** Name of the workspace the invite link is for. */
3871
+ organizationName?: string;
3872
+ /** Region of the workspace the invite link is for. */
3873
+ organizationRegion?: string;
3874
+ /** URL key of the workspace the invite link is for. */
3875
+ organizationUrlKey?: string;
3876
+ }
3823
3877
  /**
3824
3878
  * OrganizationInvitePayload model
3825
3879
  *
@@ -3851,6 +3905,19 @@ export declare class OrganizationPayload extends Request {
3851
3905
  /** The organization that was created or updated. */
3852
3906
  get organization(): LinearFetch<Organization>;
3853
3907
  }
3908
+ /**
3909
+ * OrganizationRegionResponse model
3910
+ *
3911
+ * @param request - function to call the graphql client
3912
+ * @param data - L.OrganizationRegionResponseFragment response data
3913
+ */
3914
+ export declare class OrganizationRegionResponse extends Request {
3915
+ constructor(request: LinearRequest, data: L.OrganizationRegionResponseFragment);
3916
+ /** The region for the organization. */
3917
+ region?: string;
3918
+ /** Whether the operation was successful. */
3919
+ success: boolean;
3920
+ }
3854
3921
  /**
3855
3922
  * OrganizationStartPlusTrialPayload model
3856
3923
  *
@@ -3941,6 +4008,7 @@ export declare class PaidSubscription extends Request {
3941
4008
  export declare class Project extends Request {
3942
4009
  private _convertedFromIssue?;
3943
4010
  private _creator?;
4011
+ private _favorite?;
3944
4012
  private _integrationsSettings?;
3945
4013
  private _lastAppliedTemplate?;
3946
4014
  private _lead?;
@@ -3997,7 +4065,7 @@ export declare class Project extends Request {
3997
4065
  startDate?: L.Scalars["TimelessDate"];
3998
4066
  /** The time at which the project was moved into started state. */
3999
4067
  startedAt?: Date;
4000
- /** The type of the state. */
4068
+ /** [DEPRECATED] The type of the state. */
4001
4069
  state: string;
4002
4070
  /** The estimated completion date of the project. */
4003
4071
  targetDate?: L.Scalars["TimelessDate"];
@@ -4015,6 +4083,8 @@ export declare class Project extends Request {
4015
4083
  get convertedFromIssue(): LinearFetch<Issue> | undefined;
4016
4084
  /** The user who created the project. */
4017
4085
  get creator(): LinearFetch<User> | undefined;
4086
+ /** The user's favorite associated with this project. */
4087
+ get favorite(): LinearFetch<Favorite> | undefined;
4018
4088
  /** Settings for all integrations associated with that project. */
4019
4089
  get integrationsSettings(): LinearFetch<IntegrationsSettings> | undefined;
4020
4090
  /** The last template that was applied to this project. */
@@ -4351,6 +4421,7 @@ export declare class ProjectSearchPayload extends Request {
4351
4421
  export declare class ProjectSearchResult extends Request {
4352
4422
  private _convertedFromIssue?;
4353
4423
  private _creator?;
4424
+ private _favorite?;
4354
4425
  private _integrationsSettings?;
4355
4426
  private _lastAppliedTemplate?;
4356
4427
  private _lead?;
@@ -4409,7 +4480,7 @@ export declare class ProjectSearchResult extends Request {
4409
4480
  startDate?: L.Scalars["TimelessDate"];
4410
4481
  /** The time at which the project was moved into started state. */
4411
4482
  startedAt?: Date;
4412
- /** The type of the state. */
4483
+ /** [DEPRECATED] The type of the state. */
4413
4484
  state: string;
4414
4485
  /** The estimated completion date of the project. */
4415
4486
  targetDate?: L.Scalars["TimelessDate"];
@@ -4427,6 +4498,8 @@ export declare class ProjectSearchResult extends Request {
4427
4498
  get convertedFromIssue(): LinearFetch<Issue> | undefined;
4428
4499
  /** The user who created the project. */
4429
4500
  get creator(): LinearFetch<User> | undefined;
4501
+ /** The user's favorite associated with this project. */
4502
+ get favorite(): LinearFetch<Favorite> | undefined;
4430
4503
  /** Settings for all integrations associated with that project. */
4431
4504
  get integrationsSettings(): LinearFetch<IntegrationsSettings> | undefined;
4432
4505
  /** The last template that was applied to this project. */
@@ -4928,6 +5001,21 @@ export declare class SentrySettings extends Request {
4928
5001
  /** The slug of the Sentry organization being connected. */
4929
5002
  organizationSlug: string;
4930
5003
  }
5004
+ /**
5005
+ * Shared Slack integration settings.
5006
+ *
5007
+ * @param request - function to call the graphql client
5008
+ * @param data - L.SharedSlackSettingsFragment response data
5009
+ */
5010
+ export declare class SharedSlackSettings extends Request {
5011
+ constructor(request: LinearRequest, data: L.SharedSlackSettingsFragment);
5012
+ /** Enterprise name of the connected Slack enterprise */
5013
+ enterpriseName?: string;
5014
+ /** Slack workspace id */
5015
+ teamId?: string;
5016
+ /** Slack workspace name */
5017
+ teamName?: string;
5018
+ }
4931
5019
  /**
4932
5020
  * Slack Asks specific settings.
4933
5021
  *
@@ -4936,6 +5024,12 @@ export declare class SentrySettings extends Request {
4936
5024
  */
4937
5025
  export declare class SlackAsksSettings extends Request {
4938
5026
  constructor(request: LinearRequest, data: L.SlackAsksSettingsFragment);
5027
+ /** Enterprise name of the connected Slack enterprise */
5028
+ enterpriseName?: string;
5029
+ /** Slack workspace id */
5030
+ teamId?: string;
5031
+ /** Slack workspace name */
5032
+ teamName?: string;
4939
5033
  /** The mapping of Slack channel ID => Slack channel name for connected channels. */
4940
5034
  slackChannelMapping?: SlackChannelNameMapping[];
4941
5035
  }
@@ -5023,8 +5117,14 @@ export declare class SlackPostSettings extends Request {
5023
5117
  */
5024
5118
  export declare class SlackSettings extends Request {
5025
5119
  constructor(request: LinearRequest, data: L.SlackSettingsFragment);
5120
+ /** Enterprise name of the connected Slack enterprise */
5121
+ enterpriseName?: string;
5026
5122
  /** Whether Linear should automatically respond with issue unfurls when an issue identifier is mentioned in a Slack message. */
5027
5123
  linkOnIssueIdMention: boolean;
5124
+ /** Slack workspace id */
5125
+ teamId?: string;
5126
+ /** Slack workspace name */
5127
+ teamName?: string;
5028
5128
  }
5029
5129
  /**
5030
5130
  * SsoUrlFromEmailResponse model
@@ -5508,7 +5608,7 @@ export declare class TimeScheduleEntry extends Request {
5508
5608
  endsAt: Date;
5509
5609
  /** The start date of the schedule in ISO 8601 date-time format. */
5510
5610
  startsAt: Date;
5511
- /** The email of the user on schedule. This is used in case the external user could not be mapped to a Linear user id. */
5611
+ /** The email, name or reference to the user on schedule. This is used in case the external user could not be mapped to a Linear user id. */
5512
5612
  userEmail?: string;
5513
5613
  /** The Linear user id of the user on schedule. If the user cannot be mapped to a Linear user then `userEmail` can be used as a reference. */
5514
5614
  userId?: string;
@@ -7107,6 +7207,21 @@ export declare class OrganizationInvitesQuery extends Request {
7107
7207
  */
7108
7208
  fetch(variables?: L.OrganizationInvitesQueryVariables): LinearFetch<OrganizationInviteConnection>;
7109
7209
  }
7210
+ /**
7211
+ * A fetchable OrganizationRegion Query
7212
+ *
7213
+ * @param request - function to call the graphql client
7214
+ */
7215
+ export declare class OrganizationRegionQuery extends Request {
7216
+ constructor(request: LinearRequest);
7217
+ /**
7218
+ * Call the OrganizationRegion query and return a OrganizationRegionResponse
7219
+ *
7220
+ * @param id - required id to pass to organizationRegion
7221
+ * @returns parsed response from OrganizationRegionQuery
7222
+ */
7223
+ fetch(id: string): LinearFetch<OrganizationRegionResponse>;
7224
+ }
7110
7225
  /**
7111
7226
  * A fetchable Project Query
7112
7227
  *
@@ -7912,21 +8027,6 @@ export declare class AttachmentLinkZendeskMutation extends Request {
7912
8027
  */
7913
8028
  fetch(issueId: string, ticketId: string, variables?: Omit<L.AttachmentLinkZendeskMutationVariables, "issueId" | "ticketId">): LinearFetch<AttachmentPayload>;
7914
8029
  }
7915
- /**
7916
- * A fetchable AttachmentUnsyncSlack Mutation
7917
- *
7918
- * @param request - function to call the graphql client
7919
- */
7920
- export declare class AttachmentUnsyncSlackMutation extends Request {
7921
- constructor(request: LinearRequest);
7922
- /**
7923
- * Call the AttachmentUnsyncSlack mutation and return a AttachmentPayload
7924
- *
7925
- * @param id - required id to pass to attachmentUnsyncSlack
7926
- * @returns parsed response from AttachmentUnsyncSlackMutation
7927
- */
7928
- fetch(id: string): LinearFetch<AttachmentPayload>;
7929
- }
7930
8030
  /**
7931
8031
  * A fetchable UpdateAttachment Mutation
7932
8032
  *
@@ -12593,6 +12693,13 @@ export declare class LinearSdk extends Request {
12593
12693
  * @returns OrganizationInviteConnection
12594
12694
  */
12595
12695
  organizationInvites(variables?: L.OrganizationInvitesQueryVariables): LinearFetch<OrganizationInviteConnection>;
12696
+ /**
12697
+ * Fetch the region for the organization.
12698
+ *
12699
+ * @param id - required id to pass to organizationRegion
12700
+ * @returns OrganizationRegionResponse
12701
+ */
12702
+ organizationRegion(id: string): LinearFetch<OrganizationRegionResponse>;
12596
12703
  /**
12597
12704
  * One specific project.
12598
12705
  *
@@ -12982,13 +13089,6 @@ export declare class LinearSdk extends Request {
12982
13089
  * @returns AttachmentPayload
12983
13090
  */
12984
13091
  attachmentLinkZendesk(issueId: string, ticketId: string, variables?: Omit<L.AttachmentLinkZendeskMutationVariables, "issueId" | "ticketId">): LinearFetch<AttachmentPayload>;
12985
- /**
12986
- * [DEPRECATED] Unsyncs an existing synced Slack attachment.
12987
- *
12988
- * @param id - required id to pass to attachmentUnsyncSlack
12989
- * @returns AttachmentPayload
12990
- */
12991
- attachmentUnsyncSlack(id: string): LinearFetch<AttachmentPayload>;
12992
13092
  /**
12993
13093
  * Updates an existing issue attachment.
12994
13094
  *
@@ -13174,7 +13274,7 @@ export declare class LinearSdk extends Request {
13174
13274
  */
13175
13275
  emailTokenUserAccountAuth(input: L.TokenUserAccountAuthInput): LinearFetch<AuthResolverResponse>;
13176
13276
  /**
13177
- * Unsubscribes the user from one type of emails.
13277
+ * Unsubscribes the user from one type of email.
13178
13278
  *
13179
13279
  * @param input - required input to pass to emailUnsubscribe
13180
13280
  * @returns EmailUnsubscribePayload