@linear/sdk 18.0.0 → 19.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.
@@ -10,6 +10,12 @@ export declare type LinearRequest = <Response, Variables extends Record<string,
10
10
  export declare class Request {
11
11
  protected _request: LinearRequest;
12
12
  constructor(request: LinearRequest);
13
+ /**
14
+ * Helper to paginate over all pages of a given connection query.
15
+ * @param fn The query to paginate
16
+ * @param args The arguments to pass to the query
17
+ */
18
+ paginate<T extends Node, U>(fn: (variables: U) => LinearFetch<Connection<T>>, args: U): Promise<T[]>;
13
19
  }
14
20
  /** Fetch return type wrapped in a promise */
15
21
  export declare type LinearFetch<Response> = Promise<Response>;
@@ -391,6 +397,25 @@ export declare class AuthApiKeyPayload extends Request {
391
397
  /** The auth API key that was created. */
392
398
  authApiKey: AuthApiKey;
393
399
  }
400
+ /**
401
+ * An email address that can be used for submitting issues.
402
+ *
403
+ * @param request - function to call the graphql client
404
+ * @param data - L.AuthEmailIntakeAddressFragment response data
405
+ */
406
+ export declare class AuthEmailIntakeAddress extends Request {
407
+ constructor(request: LinearRequest, data: L.AuthEmailIntakeAddressFragment);
408
+ /** Unique email address user name (before @) used for incoming email. */
409
+ address: string;
410
+ /** Whether the email address is enabled. */
411
+ enabled: boolean;
412
+ /** The unique identifier of the entity. */
413
+ id: string;
414
+ /** The auth user who created the email intake address. */
415
+ creator?: AuthUser;
416
+ /** The auth organization that the email address is associated with. */
417
+ organization: AuthOrganization;
418
+ }
394
419
  /**
395
420
  * AuthIntegration model
396
421
  *
@@ -515,6 +540,8 @@ export declare class AuthOrganization extends Request {
515
540
  name: string;
516
541
  /** Previously used URL keys for the organization (last 3 are kept and redirected). */
517
542
  previousUrlKeys: string[];
543
+ /** The region the organization is hosted in. */
544
+ region: string;
518
545
  /** Whether SAML authentication is enabled for organization. */
519
546
  samlEnabled: boolean;
520
547
  /** Whether SCIM provisioning is enabled for organization. */
@@ -1223,6 +1250,8 @@ export declare class Document extends Request {
1223
1250
  content?: string;
1224
1251
  /** The time at which the entity was created. */
1225
1252
  createdAt: Date;
1253
+ /** The time at which the document was hidden. Null if the entity has not been hidden. */
1254
+ hiddenAt?: Date;
1226
1255
  /** The icon of the document. */
1227
1256
  icon?: string;
1228
1257
  /** The unique identifier of the entity. */
@@ -1411,6 +1440,8 @@ export declare class DocumentSearchResult extends Request {
1411
1440
  content?: string;
1412
1441
  /** The time at which the entity was created. */
1413
1442
  createdAt: Date;
1443
+ /** The time at which the document was hidden. Null if the entity has not been hidden. */
1444
+ hiddenAt?: Date;
1414
1445
  /** The icon of the document. */
1415
1446
  icon?: string;
1416
1447
  /** The unique identifier of the entity. */
@@ -3811,6 +3842,8 @@ export declare class OrganizationInviteFullDetailsPayload extends Request {
3811
3842
  constructor(request: LinearRequest, data: L.OrganizationInviteFullDetailsPayloadFragment);
3812
3843
  /** Whether the invite has already been accepted. */
3813
3844
  accepted: boolean;
3845
+ /** Allowed authentication providers, empty array means all are allowed. */
3846
+ allowedAuthServices: string[];
3814
3847
  /** When the invite was created. */
3815
3848
  createdAt: Date;
3816
3849
  /** The email of the invitee. */
@@ -3826,6 +3859,27 @@ export declare class OrganizationInviteFullDetailsPayload extends Request {
3826
3859
  /** Name of the workspace the invite is for. */
3827
3860
  organizationName: string;
3828
3861
  }
3862
+ /**
3863
+ * OrganizationInviteLinkDetailsPayload model
3864
+ *
3865
+ * @param request - function to call the graphql client
3866
+ * @param data - L.OrganizationInviteLinkDetailsPayloadFragment response data
3867
+ */
3868
+ export declare class OrganizationInviteLinkDetailsPayload extends Request {
3869
+ constructor(request: LinearRequest, data: L.OrganizationInviteLinkDetailsPayloadFragment);
3870
+ /** Allowed authentication providers, empty array means all are allowed. */
3871
+ allowedAuthServices: string[];
3872
+ /** ID of the workspace the invite link is for. */
3873
+ organizationId?: string;
3874
+ /** URL of the workspace logo the invite link is for. */
3875
+ organizationLogoUrl?: string;
3876
+ /** Name of the workspace the invite link is for. */
3877
+ organizationName?: string;
3878
+ /** Region of the workspace the invite link is for. */
3879
+ organizationRegion?: string;
3880
+ /** URL key of the workspace the invite link is for. */
3881
+ organizationUrlKey?: string;
3882
+ }
3829
3883
  /**
3830
3884
  * OrganizationInvitePayload model
3831
3885
  *
@@ -3857,6 +3911,19 @@ export declare class OrganizationPayload extends Request {
3857
3911
  /** The organization that was created or updated. */
3858
3912
  get organization(): LinearFetch<Organization>;
3859
3913
  }
3914
+ /**
3915
+ * OrganizationRegionResponse model
3916
+ *
3917
+ * @param request - function to call the graphql client
3918
+ * @param data - L.OrganizationRegionResponseFragment response data
3919
+ */
3920
+ export declare class OrganizationRegionResponse extends Request {
3921
+ constructor(request: LinearRequest, data: L.OrganizationRegionResponseFragment);
3922
+ /** The region for the organization. */
3923
+ region?: string;
3924
+ /** Whether the operation was successful. */
3925
+ success: boolean;
3926
+ }
3860
3927
  /**
3861
3928
  * OrganizationStartPlusTrialPayload model
3862
3929
  *
@@ -3947,6 +4014,7 @@ export declare class PaidSubscription extends Request {
3947
4014
  export declare class Project extends Request {
3948
4015
  private _convertedFromIssue?;
3949
4016
  private _creator?;
4017
+ private _favorite?;
3950
4018
  private _integrationsSettings?;
3951
4019
  private _lastAppliedTemplate?;
3952
4020
  private _lead?;
@@ -4003,7 +4071,7 @@ export declare class Project extends Request {
4003
4071
  startDate?: L.Scalars["TimelessDate"];
4004
4072
  /** The time at which the project was moved into started state. */
4005
4073
  startedAt?: Date;
4006
- /** The type of the state. */
4074
+ /** [DEPRECATED] The type of the state. */
4007
4075
  state: string;
4008
4076
  /** The estimated completion date of the project. */
4009
4077
  targetDate?: L.Scalars["TimelessDate"];
@@ -4021,6 +4089,8 @@ export declare class Project extends Request {
4021
4089
  get convertedFromIssue(): LinearFetch<Issue> | undefined;
4022
4090
  /** The user who created the project. */
4023
4091
  get creator(): LinearFetch<User> | undefined;
4092
+ /** The user's favorite associated with this project. */
4093
+ get favorite(): LinearFetch<Favorite> | undefined;
4024
4094
  /** Settings for all integrations associated with that project. */
4025
4095
  get integrationsSettings(): LinearFetch<IntegrationsSettings> | undefined;
4026
4096
  /** The last template that was applied to this project. */
@@ -4357,6 +4427,7 @@ export declare class ProjectSearchPayload extends Request {
4357
4427
  export declare class ProjectSearchResult extends Request {
4358
4428
  private _convertedFromIssue?;
4359
4429
  private _creator?;
4430
+ private _favorite?;
4360
4431
  private _integrationsSettings?;
4361
4432
  private _lastAppliedTemplate?;
4362
4433
  private _lead?;
@@ -4415,7 +4486,7 @@ export declare class ProjectSearchResult extends Request {
4415
4486
  startDate?: L.Scalars["TimelessDate"];
4416
4487
  /** The time at which the project was moved into started state. */
4417
4488
  startedAt?: Date;
4418
- /** The type of the state. */
4489
+ /** [DEPRECATED] The type of the state. */
4419
4490
  state: string;
4420
4491
  /** The estimated completion date of the project. */
4421
4492
  targetDate?: L.Scalars["TimelessDate"];
@@ -4433,6 +4504,8 @@ export declare class ProjectSearchResult extends Request {
4433
4504
  get convertedFromIssue(): LinearFetch<Issue> | undefined;
4434
4505
  /** The user who created the project. */
4435
4506
  get creator(): LinearFetch<User> | undefined;
4507
+ /** The user's favorite associated with this project. */
4508
+ get favorite(): LinearFetch<Favorite> | undefined;
4436
4509
  /** Settings for all integrations associated with that project. */
4437
4510
  get integrationsSettings(): LinearFetch<IntegrationsSettings> | undefined;
4438
4511
  /** The last template that was applied to this project. */
@@ -4942,6 +5015,8 @@ export declare class SentrySettings extends Request {
4942
5015
  */
4943
5016
  export declare class SharedSlackSettings extends Request {
4944
5017
  constructor(request: LinearRequest, data: L.SharedSlackSettingsFragment);
5018
+ /** Enterprise name of the connected Slack enterprise */
5019
+ enterpriseName?: string;
4945
5020
  /** Slack workspace id */
4946
5021
  teamId?: string;
4947
5022
  /** Slack workspace name */
@@ -4955,6 +5030,8 @@ export declare class SharedSlackSettings extends Request {
4955
5030
  */
4956
5031
  export declare class SlackAsksSettings extends Request {
4957
5032
  constructor(request: LinearRequest, data: L.SlackAsksSettingsFragment);
5033
+ /** Enterprise name of the connected Slack enterprise */
5034
+ enterpriseName?: string;
4958
5035
  /** Slack workspace id */
4959
5036
  teamId?: string;
4960
5037
  /** Slack workspace name */
@@ -5046,6 +5123,8 @@ export declare class SlackPostSettings extends Request {
5046
5123
  */
5047
5124
  export declare class SlackSettings extends Request {
5048
5125
  constructor(request: LinearRequest, data: L.SlackSettingsFragment);
5126
+ /** Enterprise name of the connected Slack enterprise */
5127
+ enterpriseName?: string;
5049
5128
  /** Whether Linear should automatically respond with issue unfurls when an issue identifier is mentioned in a Slack message. */
5050
5129
  linkOnIssueIdMention: boolean;
5051
5130
  /** Slack workspace id */
@@ -7896,14 +7975,12 @@ export declare class AttachmentLinkSlackMutation extends Request {
7896
7975
  /**
7897
7976
  * Call the AttachmentLinkSlack mutation and return a AttachmentPayload
7898
7977
  *
7899
- * @param channel - required channel to pass to attachmentLinkSlack
7900
7978
  * @param issueId - required issueId to pass to attachmentLinkSlack
7901
- * @param latest - required latest to pass to attachmentLinkSlack
7902
7979
  * @param url - required url to pass to attachmentLinkSlack
7903
- * @param variables - variables without 'channel', 'issueId', 'latest', 'url' to pass into the AttachmentLinkSlackMutation
7980
+ * @param variables - variables without 'issueId', 'url' to pass into the AttachmentLinkSlackMutation
7904
7981
  * @returns parsed response from AttachmentLinkSlackMutation
7905
7982
  */
7906
- fetch(channel: string, issueId: string, latest: string, url: string, variables?: Omit<L.AttachmentLinkSlackMutationVariables, "channel" | "issueId" | "latest" | "url">): LinearFetch<AttachmentPayload>;
7983
+ fetch(issueId: string, url: string, variables?: Omit<L.AttachmentLinkSlackMutationVariables, "issueId" | "url">): LinearFetch<AttachmentPayload>;
7907
7984
  }
7908
7985
  /**
7909
7986
  * A fetchable AttachmentLinkUrl Mutation
@@ -12968,14 +13045,12 @@ export declare class LinearSdk extends Request {
12968
13045
  /**
12969
13046
  * Link an existing Slack message to an issue.
12970
13047
  *
12971
- * @param channel - required channel to pass to attachmentLinkSlack
12972
13048
  * @param issueId - required issueId to pass to attachmentLinkSlack
12973
- * @param latest - required latest to pass to attachmentLinkSlack
12974
13049
  * @param url - required url to pass to attachmentLinkSlack
12975
- * @param variables - variables without 'channel', 'issueId', 'latest', 'url' to pass into the AttachmentLinkSlackMutation
13050
+ * @param variables - variables without 'issueId', 'url' to pass into the AttachmentLinkSlackMutation
12976
13051
  * @returns AttachmentPayload
12977
13052
  */
12978
- attachmentLinkSlack(channel: string, issueId: string, latest: string, url: string, variables?: Omit<L.AttachmentLinkSlackMutationVariables, "channel" | "issueId" | "latest" | "url">): LinearFetch<AttachmentPayload>;
13053
+ attachmentLinkSlack(issueId: string, url: string, variables?: Omit<L.AttachmentLinkSlackMutationVariables, "issueId" | "url">): LinearFetch<AttachmentPayload>;
12979
13054
  /**
12980
13055
  * Link any url to an issue.
12981
13056
  *
@@ -13179,7 +13254,7 @@ export declare class LinearSdk extends Request {
13179
13254
  */
13180
13255
  emailTokenUserAccountAuth(input: L.TokenUserAccountAuthInput): LinearFetch<AuthResolverResponse>;
13181
13256
  /**
13182
- * Unsubscribes the user from one type of emails.
13257
+ * Unsubscribes the user from one type of email.
13183
13258
  *
13184
13259
  * @param input - required input to pass to emailUnsubscribe
13185
13260
  * @returns EmailUnsubscribePayload