-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema.graphql
More file actions
1560 lines (1434 loc) · 35.1 KB
/
schema.graphql
File metadata and controls
1560 lines (1434 loc) · 35.1 KB
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 Ability {
can_manage_conventions: Boolean!
can_update_convention: Boolean!
can_update_departments: Boolean!
can_read_organizations: Boolean!
can_read_user_activity_alerts: Boolean!
can_manage_email_routes: Boolean!
can_read_schedule: Boolean!
can_read_schedule_with_counts: Boolean!
can_list_events: Boolean!
can_update_event(eventId: ID): Boolean!
can_delete_event(eventId: ID): Boolean! @deprecated(reason: "Deleting events is never allowed; this always returns false")
can_read_event_signups(eventId: ID): Boolean!
can_read_admin_notes_on_event_proposal(eventProposalId: ID): Boolean!
can_update_admin_notes_on_event_proposal(eventProposalId: ID): Boolean!
can_update_event_proposal(eventProposalId: ID): Boolean!
can_delete_event_proposal(eventProposalId: ID): Boolean!
can_override_maximum_event_provided_tickets: Boolean!
can_update_event_categories: Boolean!
can_read_event_proposals: Boolean!
can_manage_rooms: Boolean!
can_manage_runs: Boolean!
can_read_orders: Boolean!
can_create_orders: Boolean!
can_update_orders: Boolean!
can_update_products: Boolean!
can_manage_ticket_types: Boolean!
can_create_tickets: Boolean!
can_delete_ticket(ticketId: ID): Boolean!
can_update_ticket(ticketId: ID): Boolean!
can_create_cms_files: Boolean!
can_create_pages: Boolean!
can_create_cms_partials: Boolean!
can_create_cms_layouts: Boolean!
can_create_cms_navigation_items: Boolean!
can_create_cms_variables: Boolean!
can_create_cms_graphql_queries: Boolean!
can_create_cms_content_groups: Boolean!
can_manage_any_cms_content: Boolean!
can_update_notification_templates: Boolean!
can_manage_forms: Boolean!
can_read_any_mailing_list: Boolean!
can_read_reports: Boolean!
can_read_signups: Boolean!
can_manage_signups: Boolean!
can_force_confirm_signup(signupId: ID): Boolean!
can_update_bucket_signup(signupId: ID): Boolean!
can_update_counted_signup(signupId: ID): Boolean!
can_update_signup(signupId: ID): Boolean!
can_update_signups: Boolean!
can_manage_oauth_applications: Boolean!
can_manage_staff_positions: Boolean!
can_read_user_con_profiles: Boolean!
can_create_user_con_profiles: Boolean!
can_become_user_con_profile(userConProfileId: ID): Boolean!
can_delete_user_con_profile(userConProfileId: ID): Boolean!
can_update_user_con_profile(userConProfileId: ID): Boolean!
can_read_users: Boolean!
can_withdraw_all_user_con_profile_signups(userConProfileId: ID): Boolean!
}
"""
Despite the name, this actually represents an active_storage_blob model. Whoops...
"""
type ActiveStorageAttachment {
id: ID!
byte_size: Int!
content_type: String!
filename: String!
resized_url(maxWidth: Int!, maxHeight: Int!): String
url: String!
}
scalar BigDecimal
union CmsContent = Page | CmsPartial | CmsLayout
type CmsContentGroup {
id: ID!
contents: [CmsContent!]!
current_ability_can_delete: Boolean!
current_ability_can_update: Boolean!
name: String!
permissions: [Permission!]!
}
type CmsFile {
id: ID!
current_ability_can_delete: Boolean!
file: ActiveStorageAttachment!
}
type CmsGraphqlQuery {
id: ID!
admin_notes: String
current_ability_can_delete: Boolean!
current_ability_can_update: Boolean!
identifier: String!
query: String!
}
type CmsLayout {
id: ID!
admin_notes: String
content: String
content_html(path: String): String
content_html_with_placeholders(path: String): String
current_ability_can_delete: Boolean!
current_ability_can_update: Boolean!
name: String
navbar_classes: String
}
type CmsNavigationItem {
id: ID!
navigation_section: CmsNavigationItem
page: Page
position: Int
title: String
}
interface CmsParent {
id: ID!
site_name: String!
cmsFiles: [CmsFile!]!
cmsFile(id: ID!): CmsFile!
cmsGraphqlQueries: [CmsGraphqlQuery!]!
cmsGraphqlQuery(id: ID!): CmsGraphqlQuery!
cmsLayouts: [CmsLayout!]!
cmsLayout(id: ID!): CmsLayout!
cmsNavigationItems: [CmsNavigationItem!]!
cmsPages: [Page!]!
cmsPage(id: ID, slug: String, rootPage: Boolean): Page!
cmsPartials: [CmsPartial!]!
cmsVariables: [CmsVariable!]!
defaultLayout: CmsLayout!
effectiveCmsLayout(path: String!): CmsLayout!
host: String!
liquidAssigns: [LiquidAssign!]!
previewLiquid(content: String!): String!
previewMarkdown(markdown: String!, eventId: ID, eventProposalId: ID): String!
rootPage: Page!
typeaheadSearchCmsContent(name: String): [CmsContent!]!
url: String!
cmsContentGroups: [CmsContentGroup!]!
cmsContentGroup(id: ID!): CmsContentGroup!
}
type CmsPartial {
id: ID!
admin_notes: String
content: String
current_ability_can_delete: Boolean!
current_ability_can_update: Boolean!
name: String!
}
type CmsVariable {
id: ID!
current_ability_can_delete: Boolean!
current_ability_can_update: Boolean!
key: String!
value_json: String!
}
type ContactEmail {
email: String!
formatted_address: String!
metadata_json: Json!
name: String!
}
type Convention implements CmsParent {
id: ID!
clickwrap_agreement_html: String
cmsFiles: [CmsFile!]!
cmsFile(id: ID!): CmsFile!
cmsGraphqlQueries: [CmsGraphqlQuery!]!
cmsGraphqlQuery(id: ID!): CmsGraphqlQuery!
cmsLayouts: [CmsLayout!]!
cmsLayout(id: ID!): CmsLayout!
cmsNavigationItems: [CmsNavigationItem!]!
cmsPages: [Page!]!
cmsPage(id: ID, slug: String, rootPage: Boolean): Page!
cmsPartials: [CmsPartial!]!
cmsVariables: [CmsVariable!]!
defaultLayout: CmsLayout!
effectiveCmsLayout(path: String!): CmsLayout!
liquidAssigns: [LiquidAssign!]!
notification_templates: [NotificationTemplate!]!
rootPage: Page!
typeaheadSearchCmsContent(name: String): [CmsContent!]!
pre_schedule_content_html: String
previewLiquid(content: String!): String!
previewMarkdown(markdown: String!, eventId: ID, eventProposalId: ID): String!
name: String!
canceled: Boolean!
clickwrap_agreement: String
created_at: Date
domain: String!
email_from: String!
email_mode: EmailMode!
ends_at: Date
event_mailing_list_domain: String
favicon: ActiveStorageAttachment
hidden: Boolean!
language: String!
location: Json
maximum_tickets: Int
open_graph_image: ActiveStorageAttachment
show_event_list: ShowSchedule!
show_schedule: ShowSchedule!
site_mode: SiteMode!
starts_at: Date
ticket_mode: TicketMode!
ticket_name: String!
ticketNamePlural: String!
timezone_mode: TimezoneMode!
timezone_name: String
updated_at: Date
accepting_proposals: Boolean!
"""
Given a Liquid text string and a notification event, renders the Liquid to HTML using the
current domain's CMS context as if it were the content for that notification type.
"""
preview_notifier_liquid(
"""
The key of the notification event to use for generating the preview.
"""
eventKey: String!, content: String!
): String!
bio_eligible_user_con_profiles: [UserConProfile!]!
catch_all_staff_position: StaffPosition
cmsContentGroups: [CmsContentGroup!]!
cmsContentGroup(id: ID!): CmsContentGroup!
coupons_paginated(page: Int, per_page: Int, filters: CouponFiltersInput, sort: [SortInput!]): CouponsPagination!
departments: [Department!]!
"""
Finds an active event by ID in this convention. If there is no event with that ID in this
convention, or the event is no longer active, errors out.
"""
event(id: ID): Event!
events(start: Date, finish: Date, includeDropped: Boolean, filters: EventFiltersInput): [Event!]!
events_paginated(page: Int, per_page: Int, filters: EventFiltersInput, sort: [SortInput!]): EventsPagination!
event_categories(current_ability_can_read_event_proposals: Boolean): [EventCategory!]!
"""
Finds an event proposal by ID in this convention. If there is no event proposal with that ID
in this convention, errors out.
"""
event_proposal(
"""
The ID of the event proposal to find.
"""
id: ID
): EventProposal!
event_proposals_paginated(page: Int, per_page: Int, filters: EventProposalFiltersInput, sort: [SortInput!]): EventProposalsPagination!
form(id: ID): Form!
forms: [Form!]!
mailing_lists: MailingLists!
my_profile: UserConProfile
"""
Returns all signups for the current user within this convention. If no user is signed in,
returns an empty array.
"""
my_signups: [Signup!]!
orders_paginated(page: Int, per_page: Int, filters: OrderFiltersInput, sort: [SortInput!]): OrdersPagination!
"""
Finds a product by ID in this convention. If there is no product with that ID in this
convention, errors out.
"""
product(id: ID!): Product!
products(only_available: Boolean, only_ticket_providing: Boolean): [Product!]!
organization: Organization
rooms: [Room!]!
"""
Finds an active run by ID in this convention. If there is no run with that ID in this
convention, or the run's event is no longer active, errors out.
"""
run(
"""
The ID of the run to find
"""
id: ID!
): Run!
signup(id: ID): Signup!
signup_requests_paginated(page: Int, per_page: Int, filters: SignupRequestFiltersInput, sort: [SortInput!]): SignupRequestsPagination!
staff_position(id: ID): StaffPosition!
staff_positions: [StaffPosition!]!
ticket_types: [TicketType!]!
user_activity_alert(id: ID!): UserActivityAlert!
user_activity_alerts: [UserActivityAlert!]!
"""
Finds a UserConProfile by ID in the convention associated with this convention. If there is
no UserConProfile with that ID in this convention, errors out.
"""
user_con_profile(
"""
The ID of the UserConProfile to find.
"""
id: ID!
): UserConProfile!
"""
Finds a UserConProfile by user ID in the convention associated with this convention. If
there is no UserConProfile with that user ID in this convention, errors out.
"""
user_con_profile_by_user_id(
"""
The user ID of the UserConProfile to find.
"""
userId: ID!
): UserConProfile!
user_con_profile_form: Form!
user_con_profiles_paginated(page: Int, per_page: Int, filters: UserConProfileFiltersInput, sort: [SortInput!]): UserConProfilesPagination!
maximum_event_signups: ScheduledValue
signup_mode: SignupMode!
signup_requests_open: Boolean!
stripe_account: StripeAccount
stripe_account_id: String
stripe_account_ready_to_charge: Boolean!
stripe_publishable_key: String
tickets_available_for_purchase: Boolean!
}
input ConventionFiltersInput {
name: String
organization_name: String
}
type ConventionsPagination implements PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
entries: [Convention!]!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
}
type Coupon {
id: ID!
code: String!
expires_at: Date
fixed_amount: Money
percent_discount: BigDecimal
usage_limit: Int
convention: Convention!
provides_product: Product
}
type CouponApplication {
id: ID!
discount: Money!
coupon: Coupon!
order: Order!
}
input CouponFiltersInput {
code: String
}
type CouponsPagination implements PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
entries: [Coupon!]!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
}
scalar Date
type Department {
id: ID!
name: String!
proposal_description: String
event_categories: [EventCategory!]!
}
enum EmailMode {
"""
Forward received emails to staff positions as configured
"""
forward
"""
Forward all received staff emails to catch-all staff position
"""
staff_emails_to_catch_all
}
type EmailRoute {
id: ID!
forward_addresses: [String!]!
receiver_address: String!
}
input EmailRouteFiltersInput {
receiver_address: String
forward_addresses: String
}
type EmailRoutesPagination implements PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
entries: [EmailRoute!]!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
}
type Event {
convention: Convention!
form: Form!
form_response_changes: [FormResponseChange!]!
event_category: EventCategory!
maximum_event_provided_tickets_overrides: [MaximumEventProvidedTicketsOverride!]!
provided_tickets: [Ticket!]!
run(id: ID): Run!
runs(start: Date, finish: Date, exclude_conflicts: Date): [Run!]!
team_members: [TeamMember!]!
ticket_types: [TicketType!]!
id: ID!
admin_notes: String
author: String
can_play_concurrently: Boolean!
con_mail_destination: String
content_warnings: String
created_at: Date
description: String
description_html: String!
email: String
images: [ActiveStorageAttachment!]!
length_seconds: Int!
my_rating: Int
organization: String
participant_communications: String
private_signup_list: Boolean!
registration_policy: RegistrationPolicy
short_blurb: String
short_blurb_html: String!
slots_limited: Boolean!
status: String!
title: String!
total_slots: Int!
url: String
current_user_form_item_viewer_role: FormItemRole!
current_user_form_item_writer_role: FormItemRole!
form_response_attrs_json(itemIdentifiers: [String!]): Json!
form_response_attrs_json_with_rendered_markdown(itemIdentifiers: [String!]): Json!
}
type EventCategory {
convention: Convention!
department: Department
event_form: Form!
event_proposal_form: Form
events_paginated(page: Int, per_page: Int, filters: EventFiltersInput, sort: [SortInput!]): EventsPagination!
proposable: Boolean!
id: ID!
can_provide_tickets: Boolean!
default_color: String!
full_color: String!
name: String!
proposal_description: String
scheduling_ui: SchedulingUi!
signed_up_color: String!
team_member_name: String!
teamMemberNamePlural: String!
}
type EventConnection {
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
A list of edges.
"""
edges: [EventEdge!]!
"""
A list of nodes.
"""
nodes: [Event!]!
}
"""
An edge in a connection.
"""
type EventEdge {
"""
The item at the end of the edge
"""
node: Event!
"""
A cursor for use in pagination
"""
cursor: String!
}
input EventFiltersInput {
category: [Int]
title: String
title_prefix: String
my_rating: [Int!]
form_items: JSON
}
type EventProposal {
convention: Convention!
event: Event
event_category: EventCategory!
form: Form!
form_response_changes: [FormResponseChange!]!
owner: UserConProfile!
id: ID!
admin_notes: String
created_at: Date!
images: [ActiveStorageAttachment!]!
length_seconds: Int
registration_policy: RegistrationPolicy!
status: String!
submitted_at: Date
title: String
updated_at: Date!
current_user_form_item_viewer_role: FormItemRole!
current_user_form_item_writer_role: FormItemRole!
form_response_attrs_json(itemIdentifiers: [String!]): Json!
form_response_attrs_json_with_rendered_markdown(itemIdentifiers: [String!]): Json!
}
input EventProposalFiltersInput {
event_category: [Int]
title: String
owner: String
status: [String]
}
type EventProposalsPagination implements PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
entries: [EventProposal!]!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
}
type EventsPagination implements PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
entries: [Event!]!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
}
type Form {
event_categories: [EventCategory!]!
form_section(id: ID!): FormSection!
form_sections: [FormSection!]!
proposal_event_categories: [EventCategory!]!
user_con_profile_conventions: [Convention!]!
id: ID!
export_json: Json!
form_type: FormType!
title: String!
}
type FormItem {
form_section: FormSection!
id: ID!
admin_description: String
default_value: Json
expose_in: [FormItemExposeIn!]
identifier: String
item_type: String!
properties: Json!
position: Int!
public_description: String
rendered_properties: Json!
visibility: FormItemRole!
writeability: FormItemRole!
}
enum FormItemExposeIn {
event_catalog
schedule_popup
}
enum FormItemRole {
normal
confirmed_attendee
team_member
all_profiles_basic_access
admin
}
type FormResponseChange {
compacted: Boolean!
created_at: Date!
field_identifier: String!
new_value: Json
notified_at: Date
previous_value: Json
updated_at: Date!
user_con_profile: UserConProfile!
}
type FormSection {
form: Form!
form_items: [FormItem!]!
id: ID!
position: Int!
title: String
}
enum FormType {
event
event_proposal
user_con_profile
}
"""
A scalar that can represent any JSON value.
"""
scalar JSON
scalar Json
type LiquidAssign {
name: String!
drop_class_name: String!
cms_variable_value_json: String
}
type MailingLists {
event_proposers: MailingListsResult!
team_members: MailingListsResult!
ticketed_attendees: MailingListsResult!
users_with_pending_bio: MailingListsResult!
whos_free(start: Date!, finish: Date!): MailingListsResult!
waitlists: [MailingListsWaitlistsResult!]!
}
type MailingListsResult {
emails: [ContactEmail!]!
metadata_fields: [String!]!
}
type MailingListsWaitlistsResult {
emails: [ContactEmail!]!
metadata_fields: [String!]!
run: Run!
}
type MaximumEventProvidedTicketsOverride {
event: Event!
ticket_type: TicketType!
id: ID!
override_value: Int!
}
type Money {
currency_code: String!
fractional: Int!
}
type Mutation {
deleteMe: Boolean!
}
type NotificationDestination {
id: ID!
staff_position: StaffPosition
user_con_profile: UserConProfile
}
type NotificationTemplate {
id: ID!
body_html: String
body_sms: String
body_text: String
event_key: String!
subject: String
}
type Order {
coupon_applications: [CouponApplication!]!
order_entries: [OrderEntry!]!
user_con_profile: UserConProfile!
id: ID!
charge_id: String
paid_at: Date
payment_amount: Money
payment_note: String
status: OrderStatus!
submitted_at: Date
total_price: Money!
}
type OrderEntry {
order: Order!
product: Product!
productVariant: ProductVariant
id: ID!
describe_products: String!
price_per_item: Money!
quantity: Int!
}
input OrderFiltersInput {
id: ID
user_name: String
status: [String!]
}
type OrderQuantityByStatus {
status: String!
quantity: Int!
}
enum OrderStatus {
"""
Order has not yet been submitted
"""
pending
"""
Order is submitted but not yet paid
"""
unpaid
"""
Order has been submitted and paid
"""
paid
"""
Order has been cancelled
"""
cancelled
}
type OrdersPagination implements PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
entries: [Order!]!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
}
type Organization {
id: ID!
current_ability_can_manage_access: Boolean!
name: String!
conventions: [Convention!]!
organization_roles: [OrganizationRole!]!
}
type OrganizationRole {
id: ID!
name: String!
organization: Organization!
permissions: [Permission!]!
users: [User!]!
}
type Page {
id: ID!
admin_notes: String
cms_layout: CmsLayout
content: String
content_html: String!
current_ability_can_delete: Boolean!
current_ability_can_update: Boolean!
hidden_from_search: Boolean!
name: String
referenced_partials: [CmsPartial!]!
skip_clickwrap_agreement: Boolean!
slug: String
}
"""
Information about pagination in a connection
"""
type PageInfo {
"""
When paginating backwards, are there more items?
"""
hasPreviousPage: Boolean!
"""
When paginating forwards, are there more items?
"""
hasNextPage: Boolean!
"""
When paginating backwards, the cursor to continue.
"""
startCursor: String
"""
When paginating forwards, the cursor to continue.
"""
endCursor: String
}
"""
PaginationInterface provides a way to use offset-based pagination on a list of objects. This
is useful for UIs such as Intercode's table views, which provide a way to jump between numbered
pages.
Page numbers in PaginationInterface are 1-based (so, the first page is page 1, then page 2,
etc.) The number of items per page can be controlled via the per_page argument on paginated
fields. It defaults to 20, and can go up to 200.
Offset-based pagination is different from
[Relay's cursor-based pagination](https://relay.dev/graphql/connections.htm) that is more
commonly used in GraphQL APIs. We chose to go with an offset-based approach due to our UI
needs, but if a cursor-based approach is desirable in the future, we may also implement Relay
connections alongside our existing pagination fields.
"""
interface PaginationInterface {
"""
The number of the page currently being returned in this query
"""
current_page: Int!
"""
The total number of pages in the paginated list
"""
total_pages: Int!
"""
The number of items per page currently being returned in this query
"""
per_page: Int!
"""
The total number of items in the paginated list (across all pages)
"""
total_entries: Int!
}
type PayWhatYouWantValue {
minimum_amount: Money
suggested_amount: Money
maximum_amount: Money
}
type Permission {
id: ID!
permission: String!
model: PermissionedModel!
role: PermissionedRole!
}
union PermissionedModel = CmsContentGroup | Convention | EventCategory
union PermissionedRole = OrganizationRole | StaffPosition
enum PricingStrategy {
"""
Fixed price
"""
fixed
"""
Price that changes over time
"""
scheduled_value
"""
Pay-what-you-want price
"""
pay_what_you_want
}
type PricingStructure {
price(time: Date): Money
pricing_strategy: PricingStrategy!
value: PricingStructureValue!
}
union PricingStructureValue = Money | ScheduledMoneyValue | PayWhatYouWantValue
type Product {
product_variants: [ProductVariant!]!
provides_ticket_type: TicketType
id: ID!
available: Boolean!
description: String
description_html: String!
image: ActiveStorageAttachment
name: String!
order_quantities_by_status: [OrderQuantityByStatus!]!
payment_options: [String!]!
pricing_structure: PricingStructure!
}
type ProductVariant {
product: Product!
id: ID!
description: String
description_html: String!
image: ActiveStorageAttachment
name: String!
order_quantities_by_status: [OrderQuantityByStatus!]!
override_pricing_structure: PricingStructure
position: Int
}
type Query {
assumedIdentityFromProfile: UserConProfile
cmsParentByDomain(domain: String!): CmsParent!
cmsParentByRequestHost: CmsParent!
conventionByDomain(domain: String!): Convention!
conventionById(id: ID!): Convention!
conventionByRequestHost: Convention!
conventionByRequestHostIfPresent: Convention
conventions_paginated(filters: ConventionFiltersInput, sort: [SortInput!], page: Int, perPage: Int): ConventionsPagination!
currentAbility: Ability!
currentUser: User
events(after: String, before: String, first: Int, last: Int): EventConnection!
organizations: [Organization!]!
rootSite: RootSite!
user(id: ID): User!
users(ids: [ID!]): [User!]!
users_paginated(page: Int, per_page: Int, filters: UserFiltersInput, sort: [SortInput!]): UsersPagination!
"""
If there is a CMS partial on the root site called `account_form_text`, renders it to HTML
and returns the result. Otherwise, returns null.
This is used by the "update your account" pages as a way to clarify that your account is
shared between multiple conventions.
"""
accountFormContentHtml: String
previewLiquid(content: String!): String!
email_routes_paginated(page: Int, per_page: Int, filters: EmailRouteFiltersInput, sort: [SortInput!]): EmailRoutesPagination!
hasOauthApplications: Boolean!
}