-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathschematic.yaml
More file actions
23970 lines (23970 loc) · 685 KB
/
schematic.yaml
File metadata and controls
23970 lines (23970 loc) · 685 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
info:
title: Schematic API
version: '0.1'
description: Schematic API
x-rules-engine-schema-version: v0f048dd3
openapi: 3.0.0
security:
- ApiKeyAuth: []
servers:
- url: https://api.schematichq.com
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-Schematic-Api-Key
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
NotFound:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
ServerError:
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
UnprocessableEntity:
description: Unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
schemas:
ActorType:
type: string
enum:
- api_key
- app_user
- stripe_app
- system
- temporary_access_token
ApiError:
type: object
properties:
error:
type: string
description: Error message
required:
- error
ApiKeyCreateResponseData:
type: object
properties:
created_at:
type: string
format: date-time
description:
type: string
nullable: true
environment_id:
type: string
nullable: true
id:
type: string
last_used_at:
type: string
format: date-time
nullable: true
name:
type: string
readonly:
type: boolean
scopes:
type: array
items:
$ref: '#/components/schemas/ApiKeyScope'
maxItems: 50
secret:
type: string
updated_at:
type: string
format: date-time
required:
- id
- created_at
- name
- readonly
- scopes
- updated_at
- secret
title: ApiKeyCreateResponseData
ApiKeyResponseData:
type: object
properties:
created_at:
type: string
format: date-time
description:
type: string
nullable: true
environment_id:
type: string
nullable: true
id:
type: string
last_used_at:
type: string
format: date-time
nullable: true
name:
type: string
readonly:
type: boolean
scopes:
type: array
items:
$ref: '#/components/schemas/ApiKeyScope'
maxItems: 50
updated_at:
type: string
format: date-time
required:
- id
- created_at
- name
- readonly
- scopes
- updated_at
title: ApiKeyResponseData
ApiKeyScope:
type: string
enum:
- admin
- capture
- read
- write
AuditLogListResponseData:
type: object
properties:
actor_type:
$ref: '#/components/schemas/ActorType'
api_key_id:
type: string
nullable: true
ended_at:
type: string
format: date-time
nullable: true
environment_id:
type: string
nullable: true
id:
type: string
maxLength: 36
minLength: 36
method:
type: string
maxLength: 10
minLength: 1
resource_id:
type: integer
nullable: true
resource_id_string:
type: string
nullable: true
maxLength: 256
resource_name:
type: string
nullable: true
maxLength: 256
resource_type:
type: string
nullable: true
maxLength: 64
resp_code:
type: integer
nullable: true
maximum: 599
minimum: 100
secondary_resource:
type: string
nullable: true
maxLength: 256
started_at:
type: string
format: date-time
url:
type: string
maxLength: 2048
minLength: 1
user_name:
type: string
nullable: true
maxLength: 256
required:
- actor_type
- method
- id
- started_at
- url
title: AuditLogListResponseData
AuditLogResponseData:
type: object
properties:
actor_type:
$ref: '#/components/schemas/ActorType'
api_key_id:
type: string
nullable: true
ended_at:
type: string
format: date-time
nullable: true
environment_id:
type: string
nullable: true
id:
type: string
maxLength: 36
minLength: 36
method:
type: string
maxLength: 10
minLength: 1
req_body:
type: string
nullable: true
resource_id:
type: integer
nullable: true
resource_id_string:
type: string
nullable: true
maxLength: 256
resource_name:
type: string
nullable: true
maxLength: 256
resource_type:
type: string
nullable: true
maxLength: 64
resp_body:
type: string
nullable: true
resp_code:
type: integer
nullable: true
maximum: 599
minimum: 100
secondary_resource:
type: string
nullable: true
maxLength: 256
started_at:
type: string
format: date-time
url:
type: string
maxLength: 2048
minLength: 1
user_id:
type: string
nullable: true
maxLength: 256
user_name:
type: string
nullable: true
maxLength: 256
required:
- actor_type
- method
- id
- started_at
- url
title: AuditLogResponseData
BillingCouponResponseData:
type: object
properties:
account_id:
type: string
amount_off:
type: integer
nullable: true
currency:
type: string
nullable: true
duration:
type: string
nullable: true
duration_in_months:
type: integer
nullable: true
environment_id:
type: string
external_id:
type: string
id:
type: string
is_active:
type: boolean
max_redemptions:
type: integer
nullable: true
metadata:
type: object
name:
type: string
percent_off:
type: number
nullable: true
provider_type:
$ref: '#/components/schemas/BillingProviderType'
times_redeemed:
type: integer
valid_from:
type: string
format: date-time
nullable: true
valid_until:
type: string
format: date-time
nullable: true
required:
- id
- account_id
- environment_id
- external_id
- is_active
- metadata
- name
- provider_type
- times_redeemed
title: BillingCouponResponseData
BillingCreditBundleResponseData:
type: object
properties:
bundle_type:
$ref: '#/components/schemas/BillingCreditBundleType'
created_at:
type: string
format: date-time
credit_description:
type: string
credit_icon:
type: string
nullable: true
credit_id:
type: string
credit_name:
type: string
expiry_type:
$ref: '#/components/schemas/BillingCreditExpiryType'
expiry_unit:
$ref: '#/components/schemas/BillingCreditExpiryUnit'
expiry_unit_count:
type: integer
nullable: true
has_grants:
type: boolean
id:
type: string
name:
type: string
plural_name:
type: string
nullable: true
price:
$ref: '#/components/schemas/BillingPriceResponseData'
quantity:
type: integer
nullable: true
singular_name:
type: string
nullable: true
status:
$ref: '#/components/schemas/BillingCreditBundleStatus'
unit_price:
$ref: '#/components/schemas/BillingPriceResponseData'
updated_at:
type: string
format: date-time
required:
- id
- credit_id
- name
- status
- bundle_type
- expiry_unit
- expiry_type
- credit_name
- has_grants
- created_at
- updated_at
title: BillingCreditBundleResponseData
BillingCreditBundleStatus:
type: string
enum:
- active
- inactive
BillingCreditBundleType:
type: string
enum:
- fixed
BillingCreditBundleView:
type: object
properties:
bundle_type:
$ref: '#/components/schemas/BillingCreditBundleType'
created_at:
type: string
format: date-time
credit_description:
type: string
credit_icon:
type: string
nullable: true
credit_id:
type: string
credit_name:
type: string
expiry_type:
$ref: '#/components/schemas/BillingCreditExpiryType'
expiry_unit:
$ref: '#/components/schemas/BillingCreditExpiryUnit'
expiry_unit_count:
type: integer
nullable: true
has_grants:
type: boolean
id:
type: string
name:
type: string
plural_name:
type: string
nullable: true
price:
$ref: '#/components/schemas/BillingProductPriceResponseData'
quantity:
type: integer
nullable: true
singular_name:
type: string
nullable: true
status:
$ref: '#/components/schemas/BillingCreditBundleStatus'
unit_price:
$ref: '#/components/schemas/BillingProductPriceResponseData'
updated_at:
type: string
format: date-time
required:
- id
- credit_id
- name
- status
- bundle_type
- expiry_unit
- expiry_type
- credit_name
- has_grants
- created_at
- updated_at
title: BillingCreditBundleView
BillingCreditBurnStrategy:
type: string
enum:
- expiration_priority
- first_in_first_out
- last_in_first_out
- plan_first_then_credit_bundles_first_in_first_out
BillingCreditExpiryType:
type: string
enum:
- duration
- end_of_billing_period
- end_of_next_billing_period
- end_of_trial
- no_expiry
BillingCreditExpiryUnit:
type: string
enum:
- billing_periods
- days
BillingCreditGrantReason:
type: string
enum:
- billing_credit_auto_topup
- free
- plan
- purchased
BillingCreditGrantResponseData:
type: object
properties:
company_id:
type: string
company_name:
type: string
created_at:
type: string
format: date-time
credit_icon:
type: string
nullable: true
credit_id:
type: string
credit_name:
type: string
expires_at:
type: string
format: date-time
nullable: true
grant_reason:
$ref: '#/components/schemas/BillingCreditGrantReason'
id:
type: string
plan_id:
type: string
nullable: true
plan_name:
type: string
nullable: true
price:
$ref: '#/components/schemas/BillingPriceResponseData'
quantity:
type: integer
quantity_remaining:
type: number
quantity_used:
type: number
renewal_enabled:
type: boolean
renewal_period:
allOf:
- $ref: '#/components/schemas/BillingPlanCreditGrantResetCadence'
nullable: true
source_label:
type: string
transfers:
type: array
items:
$ref: '#/components/schemas/CreditTransferResponseData'
updated_at:
type: string
format: date-time
valid_from:
type: string
format: date-time
nullable: true
zeroed_out_date:
type: string
format: date-time
nullable: true
zeroed_out_reason:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantZeroedOutReason'
nullable: true
required:
- id
- quantity
- quantity_remaining
- quantity_used
- company_id
- company_name
- credit_id
- credit_name
- source_label
- created_at
- updated_at
- grant_reason
- renewal_enabled
title: BillingCreditGrantResponseData
BillingCreditGrantZeroedOutReason:
type: string
enum:
- expired
- manual
- plan_change
- plan_period_reset
BillingCreditLedgerResponseData:
type: object
properties:
description:
type: string
nullable: true
icon:
type: string
nullable: true
id:
type: string
name:
type: string
plural_name:
type: string
nullable: true
singular_name:
type: string
nullable: true
required:
- id
- name
title: BillingCreditLedgerResponseData
BillingCreditResponseData:
type: object
properties:
burn_strategy:
$ref: '#/components/schemas/BillingCreditBurnStrategy'
cost_editable:
type: boolean
created_at:
type: string
format: date-time
default_expiry_unit:
$ref: '#/components/schemas/BillingCreditExpiryUnit'
default_expiry_unit_count:
type: integer
nullable: true
default_rollover_policy:
$ref: '#/components/schemas/BillingCreditRolloverPolicy'
description:
type: string
icon:
type: string
nullable: true
id:
type: string
name:
type: string
plural_name:
type: string
nullable: true
price:
$ref: '#/components/schemas/BillingPriceResponseData'
product:
$ref: '#/components/schemas/BillingProductResponseData'
singular_name:
type: string
nullable: true
updated_at:
type: string
format: date-time
required:
- id
- name
- description
- default_expiry_unit
- default_rollover_policy
- burn_strategy
- cost_editable
- created_at
- updated_at
title: BillingCreditResponseData
BillingCreditRolloverPolicy:
type: string
enum:
- expire
- none
- rollover
BillingCreditView:
type: object
properties:
account_id:
type: string
burn_strategy:
$ref: '#/components/schemas/BillingCreditBurnStrategy'
cost_editable:
type: boolean
created_at:
type: string
format: date-time
default_expiry_unit:
$ref: '#/components/schemas/BillingCreditExpiryUnit'
default_expiry_unit_count:
type: integer
nullable: true
default_rollover_policy:
$ref: '#/components/schemas/BillingCreditRolloverPolicy'
description:
type: string
environment_id:
type: string
icon:
type: string
nullable: true
id:
type: string
name:
type: string
plural_name:
type: string
nullable: true
price:
$ref: '#/components/schemas/BillingPriceView'
price_per_unit:
type: integer
nullable: true
price_per_unit_decimal:
type: string
nullable: true
product:
$ref: '#/components/schemas/BillingProductResponseData'
singular_name:
type: string
nullable: true
updated_at:
type: string
format: date-time
required:
- id
- account_id
- environment_id
- name
- description
- default_expiry_unit
- default_rollover_policy
- burn_strategy
- cost_editable
- created_at
- updated_at
title: BillingCreditView
BillingCustomerResponseData:
type: object
properties:
company_id:
type: string
nullable: true
deleted_at:
type: string
format: date-time
nullable: true
email:
type: string
external_id:
type: string
id:
type: string
name:
type: string
provider_type:
$ref: '#/components/schemas/BillingProviderType'
updated_at:
type: string
format: date-time
required:
- email
- external_id
- id
- name
- provider_type
- updated_at
title: BillingCustomerResponseData
BillingCustomerSubscription:
type: object
properties:
currency:
type: string
expired_at:
type: string
format: date-time
nullable: true
interval:
type: string
metered_usage:
type: boolean
per_unit_price:
type: integer
total_price:
type: integer
required:
- total_price
- interval
- metered_usage
- per_unit_price
- currency
title: BillingCustomerSubscription
BillingCustomerWithSubscriptionsResponseData:
type: object
properties:
company_id:
type: string
nullable: true
deleted_at:
type: string
format: date-time
nullable: true
email:
type: string
external_id:
type: string
id:
type: string
name:
type: string
provider_type:
$ref: '#/components/schemas/BillingProviderType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/BillingCustomerSubscription'
updated_at:
type: string
format: date-time
required:
- email
- external_id
- id
- name
- provider_type
- subscriptions
- updated_at
title: BillingCustomerWithSubscriptionsResponseData
BillingMeterResponseData:
type: object
properties:
dispaly_name:
type: string
event_name:
type: string
event_payload_key:
type: string
external_price_id:
type: string
id:
type: string
provider_type:
$ref: '#/components/schemas/BillingProviderType'
required:
- dispaly_name
- event_name
- event_payload_key
- external_price_id
- id
- provider_type
title: BillingMeterResponseData
BillingPlanCreditGrantResetCadence:
type: string
enum:
- daily
- monthly
- weekly
- yearly
BillingPlanCreditGrantResetStart:
type: string
enum:
- billing_period
- first_of_month
BillingPlanCreditGrantResetType:
type: string
enum:
- no_reset
- plan_period
BillingPlanCreditGrantResponseData:
type: object
properties:
auto_topup_amount:
type: integer
nullable: true
auto_topup_amount_type:
type: string
nullable: true
auto_topup_enabled:
type: boolean
auto_topup_expiry_type:
allOf:
- $ref: '#/components/schemas/BillingCreditExpiryType'
nullable: true
auto_topup_expiry_unit:
allOf:
- $ref: '#/components/schemas/BillingCreditExpiryUnit'
nullable: true
auto_topup_expiry_unit_count:
type: integer
nullable: true
auto_topup_threshold_percent:
type: integer
nullable: true
created_at:
type: string
format: date-time
credit:
$ref: '#/components/schemas/BillingCreditResponseData'
credit_amount:
type: integer
credit_id:
type: string
credit_name:
type: string
description: Use credit.name from the nested credit object instead
deprecated: true
credit_plural_name:
type: string
description: Use plural_name from the nested credit object instead
nullable: true
deprecated: true
credit_singular_name:
type: string
description: Use singular_name from the nested credit object instead
nullable: true
deprecated: true
expiry_type:
allOf:
- $ref: '#/components/schemas/BillingCreditExpiryType'
nullable: true
expiry_unit:
allOf:
- $ref: '#/components/schemas/BillingCreditExpiryUnit'
nullable: true
expiry_unit_count:
type: integer
nullable: true
id:
type: string
plan:
$ref: '#/components/schemas/PreviewObjectResponseData'
plan_id:
type: string
plan_name:
type: string
description: Use plan.name from the nested plan object instead
deprecated: true
plan_version_id:
type: string
nullable: true
reset_cadence:
allOf:
- $ref: '#/components/schemas/BillingPlanCreditGrantResetCadence'
nullable: true
reset_start:
allOf:
- $ref: '#/components/schemas/BillingPlanCreditGrantResetStart'
nullable: true
reset_type:
allOf:
- $ref: '#/components/schemas/BillingPlanCreditGrantResetType'
nullable: true
updated_at:
type: string
format: date-time
required:
- id
- credit_id
- plan_id
- plan_name
- credit_amount
- credit_name
- auto_topup_enabled
- created_at
- updated_at
title: BillingPlanCreditGrantResponseData
BillingPriceResponseData:
type: object
properties:
currency:
type: string
external_price_id:
type: string
id:
type: string
interval:
$ref: '#/components/schemas/BillingProductPriceInterval'
price:
type: integer
price_decimal:
type: string
nullable: true
provider_type:
$ref: '#/components/schemas/BillingProviderType'
scheme:
$ref: '#/components/schemas/BillingPriceScheme'
required:
- currency
- external_price_id
- id