-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.graphql
22166 lines (18343 loc) · 415 KB
/
schema.graphql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
type PageInfo {
"""
Indicates if there are more results when paginating backward.
"""
hasPreviousPage: Boolean!
"""
Indicates if there are more results when paginating forward.
"""
hasNextPage: Boolean!
"""
Cursor representing the first result in the paginated results.
"""
startCursor: String
"""
Cursor representing the last result in the paginated results.
"""
endCursor: String
}
"""
An API key. Grants access to the user's resources.
"""
type ApiKey implements Node {
"""
The unique identifier of the entity.
"""
id: ID!
"""
The time at which the entity was created.
"""
createdAt: DateTime!
"""
The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
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
been updated after creation.
"""
updatedAt: DateTime!
"""
The time at which the entity was archived. Null if the entity has not been archived.
"""
archivedAt: DateTime
"""
The label of the API key.
"""
label: String!
}
"""
Represents a date and time in ISO 8601 format. Accepts shortcuts like `2021` to represent midnight Fri Jan 01 2021. Also accepts ISO 8601 durations strings which are added to the current date to create the represented date (e.g '-P2W1D' represents the date that was two weeks and 1 day ago)
"""
scalar DateTime
type ApiKeyEdge {
node: ApiKey!
"""
Used in `before` and `after` args
"""
cursor: String!
}
type ApiKeyConnection {
edges: [ApiKeyEdge!]!
nodes: [ApiKey!]!
pageInfo: PageInfo!
}
"""
Join table between templates and integrations
"""
type IntegrationTemplate implements Node {
"""
The unique identifier of the entity.
"""
id: ID!
"""
The time at which the entity was created.
"""
createdAt: DateTime!
"""
The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
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
been updated after creation.
"""
updatedAt: DateTime!
"""
The time at which the entity was archived. Null if the entity has not been archived.
"""
archivedAt: DateTime
"""
The template that the integration is associated with.
"""
template: Template!
"""
The integration that the template is associated with.
"""
integration: Integration!
"""
ID of the foreign entity in the external integration this template is for, e.g., Slack channel ID.
"""
foreignEntityId: String
}
type IntegrationTemplateEdge {
node: IntegrationTemplate!
"""
Used in `before` and `after` args
"""
cursor: String!
}
type IntegrationTemplateConnection {
edges: [IntegrationTemplateEdge!]!
nodes: [IntegrationTemplate!]!
pageInfo: PageInfo!
}
"""
Tuple for mapping Slack channel IDs to names
"""
type SlackAsksTeamSettings {
"""
The Linear team ID.
"""
id: String!
"""
Whether the default Asks template is enabled in the given channel for this team
"""
hasDefaultAsk: Boolean!
}
"""
Object for mapping Slack channel IDs to names and other settings
"""
type SlackChannelNameMapping {
"""
The Slack channel ID.
"""
id: String!
"""
The Slack channel name.
"""
name: String!
"""
Whether or not the Slack channel is private
"""
isPrivate: Boolean
"""
Which teams are connected to the channel and settings for those teams
"""
teams: [SlackAsksTeamSettings!]!
"""
Whether or not top-level messages in this channel should automatically create Asks
"""
autoCreateOnMessage: Boolean
"""
Whether or not using the :ticket: emoji in this channel should automatically create Asks
"""
autoCreateOnEmoji: Boolean
}
"""
Slack Asks specific settings.
"""
type SlackAsksSettings {
"""
The mapping of Slack channel ID => Slack channel name for connected channels.
"""
slackChannelMapping: [SlackChannelNameMapping!]
}
"""
Intercom specific settings.
"""
type IntercomSettings {
"""
Whether an internal message should be added when a Linear issue changes status (for status types except completed or canceled).
"""
sendNoteOnStatusChange: Boolean
"""
Whether an internal message should be added when someone comments on an issue.
"""
sendNoteOnComment: Boolean
"""
Whether a ticket should be automatically reopened when its linked Linear issue is completed.
"""
automateTicketReopeningOnCompletion: Boolean
"""
Whether a ticket should be automatically reopened when its linked Linear issue is cancelled.
"""
automateTicketReopeningOnCancellation: Boolean
"""
Whether a ticket should be automatically reopened when a comment is posted on its linked Linear issue
"""
automateTicketReopeningOnComment: Boolean
}
"""
Front specific settings.
"""
type FrontSettings {
"""
Whether an internal message should be added when a Linear issue changes status (for status types except completed or canceled).
"""
sendNoteOnStatusChange: Boolean
"""
Whether an internal message should be added when someone comments on an issue.
"""
sendNoteOnComment: Boolean
"""
Whether a ticket should be automatically reopened when its linked Linear issue is completed.
"""
automateTicketReopeningOnCompletion: Boolean
"""
Whether a ticket should be automatically reopened when its linked Linear issue is cancelled.
"""
automateTicketReopeningOnCancellation: Boolean
"""
Whether a ticket should be automatically reopened when a comment is posted on its linked Linear issue
"""
automateTicketReopeningOnComment: Boolean
}
"""
Slack notification specific settings.
"""
type SlackPostSettings {
channel: String!
channelId: String!
configurationUrl: String!
}
"""
Metadata and settings for a GitHub integration.
"""
type GitHubSettings {
"""
The avatar URL for the GitHub organization
"""
orgAvatarUrl: String!
"""
The GitHub organization's name
"""
orgLogin: String!
"""
The names of the repositories connected for the GitHub integration
"""
repositories: [String!]
}
"""
Metadata and settings for a GitHub Sync integration.
"""
type GitHubSyncSettings {
"""
The names of the repositories connected for the GitHub integration
"""
repositories: [GitHubSyncRepo!]
"""
Mapping of team to repository for syncing
"""
teamRepoMap: [TeamRepoMapping!]
}
"""
GitHub repos available to sync.
"""
type GitHubSyncRepo {
"""
The full name of the repository.
"""
fullName: String!
"""
The GitHub repo id.
"""
id: Float!
}
"""
Tuple for mapping Linear teams to GitHub repos.
"""
type TeamRepoMapping {
"""
The Linear team id to map to the given project.
"""
linearTeamId: String!
"""
The GitHub repo id.
"""
gitHubRepoId: Float!
}
"""
Metadata and settings for a GitLab integration.
"""
type GitLabSettings {
"""
The self-hosted URL of the GitLab instance
"""
url: String
}
"""
Google Sheets specific settings.
"""
type GoogleSheetsSettings {
spreadsheetId: String!
spreadsheetUrl: String!
sheetId: Float!
updatedIssuesAt: DateTime!
}
"""
Metadata about a Jira project.
"""
type JiraProjectData {
"""
The Jira id for this project.
"""
id: String!
"""
The Jira key for this project, such as ENG.
"""
key: String!
"""
The Jira name for this project, such as Engineering.
"""
name: String!
}
"""
Tuple for mapping Jira projects to Linear teams.
"""
type JiraLinearMapping {
"""
The Jira id for this project.
"""
jiraProjectId: String!
"""
The Linear team id to map to the given project.
"""
linearTeamId: String!
}
"""
Jira specific settings.
"""
type JiraSettings {
"""
The mapping of Jira project id => Linear team id.
"""
projectMapping: [JiraLinearMapping!]
"""
The Jira projects for the organization.
"""
projects: [JiraProjectData!]!
}
"""
Notion specific settings.
"""
type NotionSettings {
"""
The ID of the Notion workspace being connected.
"""
workspaceId: String!
"""
The name of the Notion workspace being connected.
"""
workspaceName: String!
}
"""
Metadata about a PagerDuty schedule.
"""
type PagerDutyScheduleInfo {
"""
The PagerDuty schedule id.
"""
scheduleId: String!
"""
The PagerDuty schedule name.
"""
scheduleName: String!
"""
The URL of the schedule in PagerDuty's web app.
"""
url: String!
}
"""
PagerDuty specific settings.
"""
type PagerDutySettings {
"""
Metadata about a PagerDuty schedule.
"""
scheduleMapping: [PagerDutyScheduleInfo!]!
}
"""
Sentry specific settings.
"""
type SentrySettings {
"""
The slug of the Sentry organization being connected.
"""
organizationSlug: String!
}
"""
Zendesk specific settings.
"""
type ZendeskSettings {
"""
Whether an internal message should be added when a Linear issue changes status (for status types except completed or canceled).
"""
sendNoteOnStatusChange: Boolean
"""
Whether an internal message should be added when someone comments on an issue.
"""
sendNoteOnComment: Boolean
"""
Whether a ticket should be automatically reopened when its linked Linear issue is completed.
"""
automateTicketReopeningOnCompletion: Boolean
"""
Whether a ticket should be automatically reopened when its linked Linear issue is cancelled.
"""
automateTicketReopeningOnCancellation: Boolean
"""
Whether a ticket should be automatically reopened when a comment is posted on its linked Linear issue
"""
automateTicketReopeningOnComment: Boolean
"""
The subdomain of the Zendesk organization being connected.
"""
subdomain: String!
"""
The URL of the connected Zendesk organization.
"""
url: String!
"""
The ID of the Linear bot user.
"""
botUserId: String
}
"""
The integration resource's settings
"""
type IntegrationSettings {
slackAsks: SlackAsksSettings
slackPost: SlackPostSettings
slackProjectPost: SlackPostSettings
slackOrgProjectUpdatesPost: SlackPostSettings
googleSheets: GoogleSheetsSettings
gitHub: GitHubSettings
gitHubSync: GitHubSyncSettings
gitLab: GitLabSettings
sentry: SentrySettings
zendesk: ZendeskSettings
intercom: IntercomSettings
front: FrontSettings
jira: JiraSettings
notion: NotionSettings
pagerDuty: PagerDutySettings
}
"""
An integration with an external service.
"""
type Integration implements Node {
"""
The unique identifier of the entity.
"""
id: ID!
"""
The time at which the entity was created.
"""
createdAt: DateTime!
"""
The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
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
been updated after creation.
"""
updatedAt: DateTime!
"""
The time at which the entity was archived. Null if the entity has not been archived.
"""
archivedAt: DateTime
"""
The integration's type.
"""
service: String!
"""
The organization that the integration is associated with.
"""
organization: Organization!
"""
The team that the integration is associated with.
"""
team: Team
"""
The user that added the integration.
"""
creator: User!
}
type IntegrationEdge {
node: Integration!
"""
Used in `before` and `after` args
"""
cursor: String!
}
type IntegrationConnection {
edges: [IntegrationEdge!]!
nodes: [Integration!]!
pageInfo: PageInfo!
}
"""
A user that has access to the the resources of an organization.
"""
type User implements Node {
"""
The unique identifier of the entity.
"""
id: ID!
"""
The time at which the entity was created.
"""
createdAt: DateTime!
"""
The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
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
been updated after creation.
"""
updatedAt: DateTime!
"""
The time at which the entity was archived. Null if the entity has not been archived.
"""
archivedAt: DateTime
"""
The user's full name.
"""
name: String!
"""
The user's display (nick) name. Unique within each organization.
"""
displayName: String!
"""
The user's email address.
"""
email: String!
"""
An URL to the user's avatar image.
"""
avatarUrl: String
"""
Reason why is the account disabled.
"""
disableReason: String
"""
Unique hash for the user to be used in invite URLs.
"""
inviteHash: String!
"""
[DEPRECATED] Hash for the user to be used in calendar URLs.
"""
calendarHash: String
"""
A short description of the user, either its title or bio.
"""
description: String
"""
The emoji to represent the user current status.
"""
statusEmoji: String
"""
The label of the user current status.
"""
statusLabel: String
"""
A date at which the user current status should be cleared.
"""
statusUntilAt: DateTime
"""
The local timezone of the user.
"""
timezone: String
"""
Organization the user belongs to.
"""
organization: Organization!
"""
The last time the user was seen online. If null, the user is currently online.
"""
lastSeen: DateTime
"""
Whether the user is a guest in the workspace and limited to accessing a subset of teams.
"""
guest: Boolean!
"""
Whether the user account is active or disabled (suspended).
"""
active: Boolean!
"""
User's profile URL.
"""
url: String!
"""
Issues assigned to the user.
"""
assignedIssues(
"""
Filter returned issues.
"""
filter: IssueFilter
"""
A cursor to be used with last for backward pagination.
"""
before: String
"""
A cursor to be used with first for forward pagination
"""
after: String
"""
The number of items to forward paginate (used with after). Defaults to 50.
"""
first: Int
"""
The number of items to backward paginate (used with before). Defaults to 50.
"""
last: Int
"""
Should archived resources be included (default: false)
"""
includeArchived: Boolean
"""
By which field should the pagination order by. Available options are createdAt (default) and updatedAt.
"""
orderBy: PaginationOrderBy
): IssueConnection!
"""
Issues created by the user.
"""
createdIssues(
"""
Filter returned issues.
"""
filter: IssueFilter
"""
A cursor to be used with last for backward pagination.
"""
before: String
"""
A cursor to be used with first for forward pagination
"""
after: String
"""
The number of items to forward paginate (used with after). Defaults to 50.
"""
first: Int
"""
The number of items to backward paginate (used with before). Defaults to 50.
"""
last: Int
"""
Should archived resources be included (default: false)
"""
includeArchived: Boolean
"""
By which field should the pagination order by. Available options are createdAt (default) and updatedAt.
"""
orderBy: PaginationOrderBy
): IssueConnection!
"""
Number of issues created.
"""
createdIssueCount: Int!
"""
Teams the user is part of.
"""
teams(
"""
Filter returned teams.
"""
filter: TeamFilter
"""
A cursor to be used with last for backward pagination.
"""
before: String
"""
A cursor to be used with first for forward pagination
"""
after: String
"""
The number of items to forward paginate (used with after). Defaults to 50.
"""
first: Int
"""
The number of items to backward paginate (used with before). Defaults to 50.
"""
last: Int
"""
Should archived resources be included (default: false)
"""
includeArchived: Boolean
"""
By which field should the pagination order by. Available options are createdAt (default) and updatedAt.
"""
orderBy: PaginationOrderBy
): TeamConnection!
"""
Memberships associated with the user. For easier access of the same data, use `teams` query.
"""
teamMemberships(
"""
A cursor to be used with last for backward pagination.
"""
before: String
"""
A cursor to be used with first for forward pagination
"""
after: String
"""
The number of items to forward paginate (used with after). Defaults to 50.
"""
first: Int
"""
The number of items to backward paginate (used with before). Defaults to 50.
"""
last: Int
"""
Should archived resources be included (default: false)
"""
includeArchived: Boolean
"""
By which field should the pagination order by. Available options are createdAt (default) and updatedAt.
"""
orderBy: PaginationOrderBy
): TeamMembershipConnection!
"""
Whether the user is the currently authenticated user.
"""
isMe: Boolean!
"""
Whether the user is an organization administrator.
"""
admin: Boolean!
}
"""
By which field should the pagination order by
"""
enum PaginationOrderBy {
createdAt
updatedAt
}
type UserEdge {
node: User!
"""
Used in `before` and `after` args
"""
cursor: String!
}
type UserConnection {
edges: [UserEdge!]!
nodes: [User!]!
pageInfo: PageInfo!
}
"""
Contains either the full serialized state of the application or delta packets that the requester can apply to the local data set in order to be up-to-date.
"""
type SyncResponse {
"""
The full state of the organization as a serialized JSON object.
Mutually exclusive with the delta property
"""
state: String
"""
JSON serialized delta changes that the client can apply to its local state in order to catch up with the state of the world.
"""
delta: String
"""
The sync groups that the user is subscribed to.
"""
subscribedSyncGroups: [String!]!
"""
The last sync id covered by the response.
"""
lastSyncId: Float!
"""
The version of the remote database. Incremented by 1 for each migration run on the database.
"""
databaseVersion: Float!
}
"""
OAuth2 client application
"""
type OauthClient implements Node {
"""
The unique identifier of the entity.
"""
id: ID!
"""
The time at which the entity was created.
"""
createdAt: DateTime!
"""
The last time at which the entity was meaningfully updated, i.e. for all changes of syncable properties except those
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
been updated after creation.
"""
updatedAt: DateTime!
"""
The time at which the entity was archived. Null if the entity has not been archived.
"""
archivedAt: DateTime
"""
OAuth application's client ID.
"""
clientId: String!
"""
OAuth application's client name.
"""
name: String!
"""
Information about the application.
"""
description: String
"""
Name of the developer.
"""
developer: String!
"""
Url of the developer.
"""
developerUrl: String!
"""
Image of the application.
"""
imageUrl: String
"""
OAuth application's client secret.
"""
clientSecret: String!
"""
List of allowed redirect URIs for the application.
"""
redirectUris: [String!]!
"""
Whether the OAuth application can be installed in other organizations.
"""
publicEnabled: Boolean!
"""
The user who created the OAuth application.
"""
creator: User!
"""
The organization that the OAuth application is associated with.
"""
organization: Organization!
"""
The resource types to request when creating new webhooks.
"""
webhookResourceTypes: [String!]!