-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
7109 lines (7109 loc) · 181 KB
/
Copy pathopenapi.yaml
File metadata and controls
7109 lines (7109 loc) · 181 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
components:
schemas:
analyticsv1.AnalyticsEvent:
properties:
timestamp:
type: number
type: object
analyticsv1.CountryCount:
properties:
count:
type: integer
country:
type: string
type: object
analyticsv1.DashboardPoint:
properties:
timestamp:
type: string
unique_users:
type: integer
views:
type: integer
type: object
analyticsv1.DashboardStatsResponse:
properties:
points:
items:
$ref: '#/components/schemas/analyticsv1.DashboardPoint'
type: array
uniqueItems: false
type: object
analyticsv1.DateRange:
properties:
end:
type: string
start:
type: string
type: object
analyticsv1.EventCount:
properties:
count:
type: integer
event_type:
type: string
type: object
analyticsv1.FeedStats:
properties:
avg_time_per_visit_ms:
type: number
feed_id:
type: string
total_posts:
type: integer
total_views:
type: integer
total_watch_time_ms:
type: number
unique_viewers:
type: integer
type: object
analyticsv1.FunnelAnalytics:
properties:
average_time_hours:
type: number
completed_users:
type: integer
completion_rate:
type: number
steps:
items:
$ref: '#/components/schemas/analyticsv1.FunnelStepResult'
type: array
uniqueItems: false
total_users:
type: integer
type: object
analyticsv1.FunnelRequest:
properties:
range:
$ref: '#/components/schemas/analyticsv1.DateRange'
steps:
items:
$ref: '#/components/schemas/analyticsv1.FunnelStep'
type: array
uniqueItems: false
time_window:
type: integer
type: object
analyticsv1.FunnelStep:
properties:
event_type:
type: string
filters:
additionalProperties:
type: string
type: object
name:
type: string
page_type:
type: string
type: object
analyticsv1.FunnelStepResult:
properties:
conversion_rate:
type: number
dropoff_rate:
type: number
step_name:
type: string
user_count:
type: integer
type: object
analyticsv1.GetPostStatsResponse:
properties:
post_id:
type: string
total_views:
type: integer
unique_viewers:
type: integer
type: object
analyticsv1.HotSegment:
properties:
end_second:
type: integer
multiplier:
type: number
start_second:
type: integer
type: object
analyticsv1.HotSegmentsResponse:
properties:
segments:
items:
$ref: '#/components/schemas/analyticsv1.HotSegment'
type: array
uniqueItems: false
type: object
analyticsv1.PostStats:
properties:
avg_watch_time_ms:
type: number
completion_rate:
type: number
completions:
type: integer
content_type:
type: string
feed_id:
type: string
post_id:
type: string
starts:
type: integer
total_views:
type: integer
total_watch_time_ms:
type: integer
unique_viewers:
type: integer
views_by_page:
additionalProperties:
type: integer
type: object
type: object
analyticsv1.RealtimeStats:
properties:
active_users:
type: integer
events_per_minute:
type: integer
recent_events:
items:
$ref: '#/components/schemas/analyticsv1.RecentEvent'
type: array
uniqueItems: false
timestamp:
type: string
top_countries:
items:
$ref: '#/components/schemas/analyticsv1.CountryCount'
type: array
uniqueItems: false
top_events:
items:
$ref: '#/components/schemas/analyticsv1.EventCount'
type: array
uniqueItems: false
type: object
analyticsv1.RecentEvent:
properties:
content_id:
type: string
event_type:
type: string
timestamp:
type: string
user_id:
type: string
type: object
analyticsv1.RetentionAnalytics:
properties:
cohorts:
items:
$ref: '#/components/schemas/analyticsv1.RetentionCohort'
type: array
uniqueItems: false
period:
type: string
type: object
analyticsv1.RetentionCohort:
properties:
cohort_date:
type: string
cohort_size:
type: integer
retention_data:
items:
type: number
type: array
uniqueItems: false
type: object
analyticsv1.TopFeedsResponse:
properties:
feeds:
items:
$ref: '#/components/schemas/analyticsv1.FeedStats'
type: array
uniqueItems: false
type: object
analyticsv1.TopPostsResponse:
properties:
posts:
items:
$ref: '#/components/schemas/analyticsv1.PostStats'
type: array
uniqueItems: false
type: object
analyticsv1.TopVideosResponse:
properties:
videos:
items:
$ref: '#/components/schemas/analyticsv1.VideoStats'
type: array
uniqueItems: false
type: object
analyticsv1.TrackEventsRequest:
properties:
country:
type: string
events:
items:
$ref: '#/components/schemas/analyticsv1.AnalyticsEvent'
type: array
uniqueItems: false
user_id:
type: string
type: object
analyticsv1.VideoHeatmap:
properties:
data:
items:
type: number
type: array
uniqueItems: false
total_duration_ms:
type: integer
video_id:
type: string
type: object
analyticsv1.VideoStats:
properties:
avg_watch_time_ms:
type: number
completion_rate:
type: number
completions:
type: integer
starts:
type: integer
total_views:
type: integer
total_watch_time_ms:
type: number
unique_viewers:
type: integer
video_id:
type: string
watches:
type: integer
type: object
apikeysv1.ApiKey:
properties:
created_at:
type: string
expiring_at:
type: string
id:
type: string
last_used:
type: string
name:
type: string
org_id:
type: string
project_id:
type: string
project_name:
type: string
secret:
type: string
type: object
apikeysv1.CreateApiKeyResponse:
properties:
api_key:
$ref: '#/components/schemas/apikeysv1.ApiKey'
type: object
apikeysv1.DeleteApiKeyResponse:
type: object
apikeysv1.ListApiKeysResponse:
properties:
api_keys:
items:
$ref: '#/components/schemas/apikeysv1.ApiKey'
type: array
uniqueItems: false
total:
type: integer
type: object
apikeysv1.RotateApiKeyResponse:
properties:
api_key:
$ref: '#/components/schemas/apikeysv1.ApiKey'
type: object
authv1.AcceptInvitationResponse:
properties:
message:
type: string
org_id:
type: string
org_name:
type: string
role:
type: string
type: object
authv1.AuthMethod:
enum:
- 0
- 1
- 2
type: integer
x-enum-varnames:
- AuthMethod_AUTH_METHOD_UNSPECIFIED
- AuthMethod_AUTH_METHOD_PASSKEY
- AuthMethod_AUTH_METHOD_TOTP
authv1.AutoJoinSetting:
properties:
enabled:
type: boolean
present:
type: boolean
type: object
authv1.BlogSubscriptionResponse:
properties:
subscribed:
type: boolean
subscribed_at:
type: string
type: object
authv1.CheckMembershipResponse:
properties:
is_member:
type: boolean
type: object
authv1.DomainResponse:
properties:
auto_join:
type: boolean
domain:
type: string
expires_at:
type: string
id:
type: string
message:
type: string
present:
type: boolean
status:
type: string
verification_token:
type: string
verified_at:
type: string
type: object
authv1.EmailStatusResponse:
properties:
email:
type: string
has_email:
type: boolean
verified:
type: boolean
type: object
authv1.GetInternalMembershipInfoResponse:
properties:
email:
type: string
type: object
authv1.ListAttachmentsResponse:
properties:
attachments:
items:
$ref: '#/components/schemas/authv1.PolicyAttachment'
type: array
uniqueItems: false
type: object
authv1.ListMembershipsResponse:
properties:
memberships:
items:
$ref: '#/components/schemas/authv1.Membership'
type: array
uniqueItems: false
type: object
authv1.ListOrgMembersResponse:
properties:
members:
items:
$ref: '#/components/schemas/authv1.OrgMember'
type: array
uniqueItems: false
type: object
authv1.ListPasskeysResponse:
properties:
passkeys:
items:
$ref: '#/components/schemas/authv1.Passkey'
type: array
uniqueItems: false
type: object
authv1.ListPoliciesResponse:
properties:
policies:
items:
$ref: '#/components/schemas/authv1.Policy'
type: array
uniqueItems: false
type: object
authv1.ListProvidersResponse:
properties:
providers:
items:
$ref: '#/components/schemas/authv1.Provider'
type: array
uniqueItems: false
type: object
authv1.LoginResponse:
properties:
access_token:
type: string
authentication:
description: |-
authentication lists the 2FA methods the user has configured when
status is "2fa_required". The public API renders these as lowercase
strings: "passkey", "totp".
items:
$ref: '#/components/schemas/authv1.AuthMethod'
type: array
uniqueItems: false
email:
type: string
expires_in:
type: integer
passkey_options:
description: |-
passkey_options is the WebAuthn PublicKeyCredentialRequestOptions as JSON,
present only when "passkey" is one of the authentication methods.
items:
type: integer
type: array
uniqueItems: false
refresh_token:
type: string
requires_action:
type: string
session_id:
type: string
status:
description: '"ok" | "2fa_required" | "email_not_verified"'
type: string
token_type:
type: string
type: object
authv1.MemberPoliciesResponse:
properties:
permissions:
items:
type: string
type: array
uniqueItems: false
policies:
items:
$ref: '#/components/schemas/authv1.Policy'
type: array
uniqueItems: false
type: object
authv1.Membership:
properties:
id:
type: string
joined_at:
type: string
org_id:
type: string
organization_first_name:
type: string
organization_last_name:
type: string
organization_username:
type: string
role:
type: string
state:
type: string
user_id:
type: string
type: object
authv1.MembershipMutation:
properties:
joined_at:
type: string
org_id:
type: string
org_name:
type: string
role:
type: string
state:
type: string
user_id:
type: string
type: object
authv1.OTPStatusResponse:
properties:
created_at:
type: string
is_setup:
type: boolean
message:
type: string
type: object
authv1.OrgMember:
properties:
first_name:
type: string
id:
type: string
invitation_expires_at:
type: string
joined_at:
type: string
last_name:
type: string
org_id:
type: string
role:
type: string
state:
type: string
user_id:
type: string
username:
type: string
type: object
authv1.Passkey:
properties:
aaguid:
type: string
backup_state:
type: boolean
created_at:
type: string
credential_id:
type: string
id:
type: string
last_used_at:
type: string
name:
type: string
transports:
items:
type: string
type: array
uniqueItems: false
type: object
authv1.PasskeyBeginResponse:
properties:
options:
items:
type: integer
type: array
uniqueItems: false
session_id:
type: string
type: object
authv1.PasskeyRegisterFinishResponse:
properties:
name:
type: string
passkey_id:
type: string
type: object
authv1.PermissionOffset:
properties:
name:
type: string
offset:
type: integer
type: object
authv1.PermissionRegistryResponse:
properties:
permissions:
items:
$ref: '#/components/schemas/authv1.PermissionOffset'
type: array
uniqueItems: false
type: object
authv1.Policy:
properties:
created_at:
type: string
created_by:
type: string
description:
type: string
id:
type: string
name:
type: string
org_id:
type: string
permissions:
items:
type: string
type: array
uniqueItems: false
updated_at:
type: string
type: object
authv1.PolicyAttachment:
properties:
created_at:
type: string
id:
type: string
identity_id:
type: string
identity_type:
type: string
policy_id:
type: string
type: object
authv1.Provider:
properties:
email_address:
type: string
first_name:
type: string
image_url:
type: string
last_name:
type: string
provider:
type: string
username:
type: string
type: object
authv1.RegisterResponse:
properties:
email_verification_sent:
type: boolean
message:
type: string
user_id:
type: string
verification_id:
type: string
type: object
authv1.ResendVerificationResponse:
properties:
code_sent:
type: boolean
message:
type: string
verification_id:
type: string
type: object
authv1.SetupOTPResponse:
properties:
qr_code_url:
type: string
secret:
type: string
type: object
authv1.StatusResponse:
properties:
status:
type: string
type: object
authv1.TokenResponse:
properties:
access_token:
type: string
expires_in:
type: integer
refresh_token:
type: string
requires_action:
type: string
token_type:
type: string
type: object
authv1.UpdateNameResponse:
properties:
first_name:
type: string
last_name:
type: string
type: object
authv1.UpdateOrgNameResponse:
properties:
first_name:
type: string
last_name:
type: string
type: object
authv1.UpdateOrgUsernameResponse:
properties:
username:
type: string
type: object
authv1.UpdateUsernameResponse:
properties:
username:
type: string
type: object
authv1.UserInfo:
properties:
active_org_id:
type: string
country_code:
type: string
email:
type: string
email_verified:
type: boolean
first_name:
type: string
id:
type: string
image_url:
type: string
language_code:
type: string
last_name:
type: string
username:
type: string
type: object
authv1.VerificationSentResponse:
properties:
can_resend_at:
type: string
code_sent:
type: boolean
message:
type: string
verification_id:
type: string
type: object
authv1.VerifyEmailResponse:
properties:
email:
type: string
message:
type: string
tokens:
$ref: '#/components/schemas/authv1.TokenResponse'
verified:
type: boolean
type: object
billingv1.BandwidthUsage:
properties:
created_at:
type: string
data_source:
type: string
image_bandwidth_bytes:
type: integer
image_requests:
type: integer
org_id:
type: string
snapshot_date:
type: string
snapshot_type:
type: string
total_bandwidth_bytes:
type: integer
total_requests:
type: integer
unique_visitors:
type: integer
video_bandwidth_bytes:
type: integer
video_requests:
type: integer
type: object
billingv1.BillingAddress:
properties:
city:
type: string
country:
type: string
email:
type: string
line1:
type: string
line2:
type: string
name:
type: string
phone:
type: string
postal_code:
type: string
state:
type: string
type: object
billingv1.CreateSubscriptionResponse:
properties:
cancel_at_period_end:
type: boolean
current_period_end:
type: string
id:
type: string
org_id:
type: string
plan_id:
type: string
status:
type: string
stripe_customer_id:
type: string
stripe_subscription_id:
type: string
type: object
billingv1.GetBandwidthUsageHistoryResponse:
properties:
total:
type: integer
usages:
items:
$ref: '#/components/schemas/billingv1.BandwidthUsage'
type: array
uniqueItems: false
type: object
billingv1.GetPlanResponse:
properties:
currency:
type: string
description:
type: string
id:
type: string
interval:
type: string
name:
type: string
price:
type: string
type: object
billingv1.GetStorageUsageHistoryResponse:
properties:
total:
type: integer
usages:
items:
$ref: '#/components/schemas/billingv1.StorageUsage'
type: array
uniqueItems: false
type: object
billingv1.GetSubscriptionHistoryResponse:
properties:
items:
items:
$ref: '#/components/schemas/billingv1.SubscriptionHistoryItem'
type: array
uniqueItems: false
type: object
billingv1.HostedCheckoutSessionResponse:
properties:
amount:
type: number
currency:
type: string
session_id:
type: string
session_url:
type: string
status:
type: string
type: object
billingv1.Invoice:
properties:
amount:
type: string
created_at:
type: string
currency:
type: string
description:
type: string
due_date:
type: string
id:
type: string
org_id:
type: string
paid_at:
type: string
status:
type: string
subscription_id:
type: string
type: object
billingv1.ListInvoicesResponse:
properties:
invoices:
items:
$ref: '#/components/schemas/billingv1.Invoice'
type: array
uniqueItems: false
type: object
billingv1.ListPaymentMethodsResponse:
properties:
payment_methods:
items:
$ref: '#/components/schemas/billingv1.PaymentMethod'
type: array
uniqueItems: false
type: object
billingv1.ListPlansResponse:
properties:
plans:
items:
$ref: '#/components/schemas/billingv1.Plan'
type: array
uniqueItems: false
type: object
billingv1.PaymentMethod:
properties:
created_at:
type: string
details:
type: string
id:
type: string
is_default:
type: boolean
org_id:
type: string
provider:
type: string
type:
type: string
type: object
billingv1.PaymentMethodDetails:
properties:
brand:
type: string
exp_month:
type: integer
exp_year:
type: integer
id:
type: string
is_default:
type: boolean
last4:
type: string
type:
type: string
type: object
billingv1.PaymentMethodIdResponse:
properties:
payment_method_id: