-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
1228 lines (1225 loc) · 34.5 KB
/
openapi.yml
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
openapi: 3.0.0
info:
title: Journey API
description: API to configure journeys
version: 1.0.0
security:
- EpilotAuth: []
tags:
- name: Journeys
description: Journey operations
- name: Journeys V2
description: Journey V2 operations
- name: journey_schema
x-displayName: Journey
description: |
<SchemaDefinition schemaRef="#/components/schemas/Journey" />
x-tagGroups:
- name: APIs
tags:
- Journeys
- Journeys V2
- name: Schemas
tags:
- journey_schema
paths:
/v1/journey/organization/{id}:
get:
operationId: getJourneysByOrgId
summary: getJourneysByOrgId
description: Get all journeys by organization id
tags:
- Journeys
parameters:
- name: id
in: path
description: Organization ID
required: true
schema:
type: string
example: "123"
- name: hydrate
in: query
description: Hydrate
required: false
schema:
type: string
example: "true"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetJourneysResponse"
/v1/journey/configuration/{id}:
get:
operationId: getJourney
summary: getJourney
description: Get journey by id. Private journeys requires valid private token to be passed
security:
- {}
- EpilotAuth: []
tags:
- Journeys
parameters:
- name: id
in: path
description: Journey ID
required: true
schema:
type: string
format: uuid
example: 509cdffe-424f-457a-95c2-9708c304ce77
- name: source
in: query
description: What source ID. Journey or Entity ID
required: false
schema:
type: string
- name: orgId
in: query
description: Organization ID
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Journey"
delete:
operationId: removeJourney
summary: removeJourney
description: Remove journey by id
tags:
- Journeys
parameters:
- name: id
in: path
description: Journey ID
required: true
schema:
type: string
format: uuid
example: 509cdffe-424f-457a-95c2-9708c304ce77
responses:
"200":
description: Success
content: {}
/v1/journey/products/{id}:
get:
operationId: getJourneyProducts
summary: getJourneyProducts
description: Get products available in the journey by id. requires public journey token to be passed.
security:
- EpilotAuth: []
tags:
- Journeys
parameters:
- name: id
in: path
description: Journey ID
required: true
schema:
type: string
format: uuid
example: 509cdffe-424f-457a-95c2-9708c304ce77
- name: source
in: query
description: What source ID. Journey or Entity ID
required: false
schema:
type: string
- name: postal_code
in: query
description: Zip Code for availibility
required: false
schema:
type: string
- name: city
in: query
description: city for availibility
required: false
schema:
type: string
- name: street
in: query
description: street name for availibility
required: false
schema:
type: string
- name: street_number
in: query
description: street number for availibility
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyProductsResponse"
/v1/journey/configuration:
post:
operationId: createJourney
summary: createJourney
description: Create a Journey
tags:
- Journeys
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequest"
description: Payload
parameters:
- name: skipAutomation
in: query
description: skip creating an Automation (it takes Yn format "true, yes, 1, y")
required: false
schema:
type: string
format: Yn
example: true
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Journey"
put:
operationId: updateJourney
summary: updateJourney
description: Update a Journey
tags:
- Journeys
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequest"
description: Payload
parameters: []
responses:
"204":
description: Success
headers:
X-Resource-Revisions:
schema:
type: integer
minimum: 0
description: Last revisions number of the updated resource
"409":
description: The Journey has been modified since your last read, please refresh it and try again
patch:
operationId: patchUpdateJourney
summary: patchUpdateJourney
description: Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
tags:
- Journeys
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PatchUpdateJourneyRequest"
example:
journeyId: 509cdffe-424f-457a-95c2-9708c304ce77
name: New Journey Name
steps[0].uischema.elements[0].products:
- "123456"
- "654321"
description: Payload
parameters: []
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyResponse"
/v1/journey/configuration/search:
post:
operationId: searchJourneys
summary: searchJourneys
description: Search Journeys
tags:
- Journeys
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SearchJourneysQueryRequest"
description: Payload
parameters: []
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/SearchJourneysResponse"
/v1/journey/document:generate:
post:
operationId: generateDocument
summary: generateDocument
description: |
Builds document generated from a template with journey values."
Supported input document types:
- .docx
Supported output document types:
- .pdf
- .docx but limited to only text based variables
Uses [Document API](https://gitlab.com/e-pilot/product/file-management/document-api) to generate the document.
Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
security:
- {}
- EpilotAuth: []
tags:
- Journeys
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GenerateDocumentRequest"
responses:
"200":
description: Generated document output
content:
application/json:
schema:
$ref: "#/components/schemas/GenerateDocumentResponse"
/v2/journey/configuration:
post:
operationId: createJourneyV2
summary: createJourneyV2
description: Create a Journey
tags:
- Journeys V2
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequestV2"
description: Payload
parameters:
- name: skipAutomation
in: query
description: skip creating an Automation (it takes Yn format "true, yes, 1, y")
required: false
schema:
type: string
format: Yn
example: true
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequestV2"
put:
operationId: updateJourneyV2
summary: updateJourneyV2
description: Update a Journey
tags:
- Journeys V2
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequestV2"
description: Payload
parameters: []
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequestV2"
patch:
operationId: patchUpdateJourneyV2
summary: patchUpdateJourneyV2
description: Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
tags:
- Journeys V2
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PatchUpdateJourneyRequest"
example:
journeyId: 509cdffe-424f-457a-95c2-9708c304ce77
name: New Journey Name
steps[0].uischema.elements[0].products:
- "123456"
- "654321"
description: Payload
parameters: []
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequestV2"
/v2/journey/configuration/{id}:
get:
operationId: getJourneyV2
summary: getJourneyV2
description: Get journey by id
security: []
tags:
- Journeys V2
parameters:
- name: id
in: path
description: Journey ID
required: true
schema:
type: string
format: uuid
example: 509cdffe-424f-457a-95c2-9708c304ce77
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/JourneyCreationRequestV2"
delete:
operationId: removeJourneyV2
summary: removeJourneyV2
description: Remove journey by id
tags:
- Journeys V2
parameters:
- name: id
in: path
description: Journey ID
required: true
schema:
type: string
format: uuid
example: 509cdffe-424f-457a-95c2-9708c304ce77
responses:
"200":
description: Success
content: {}
components:
schemas:
GetJourneysResponse:
type: object
JourneyResponse:
type: object
properties:
createdJourney:
$ref: "#/components/schemas/Journey"
JourneyProductsResponse:
type: array
items:
type: object
properties:
type:
type: string
_schema:
type: string
_title:
type: string
name:
type: string
_id:
type: string
_org:
type: string
code:
type: string
description:
type: string
feature:
type: array
product_images:
type: array
legal_footnote:
type: string
product_downloads:
type: array
price:
type: object
PatchUpdateJourneyRequest:
type: object
properties:
journeyId:
type: string
format: uuid
example: 509cdffe-424f-457a-95c2-9708c304ce77
__lastModifiedAt:
type: string
description: If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
nullable: true
additionalProperties: true
description: |
Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
required:
- journeyId
JourneyCreationRequest:
type: object
properties:
journeyId:
type: string
organizationId:
type: string
brandId:
type: string
name:
type: string
steps:
type: array
items:
type: object
additionalProperties: false
properties:
showStepName:
type: boolean
nullable: true
title:
type: string
nullable: true
subTitle:
type: string
nullable: true
showStepSubtitle:
type: boolean
nullable: true
showStepper:
type: boolean
nullable: true
showStepperLabels:
type: boolean
nullable: true
hideNextButton:
type: boolean
nullable: true
name:
type: string
stepId:
type: string
schema: {}
uischema: {}
required:
- name
- schema
- uischema
design:
type: object
properties:
logoUrl:
type: string
nullable: true
theme:
type: object
additionalProperties: {}
required:
- theme
additionalProperties: false
rules:
type: array
items:
type: object
properties:
type:
type: string
enum:
- inject
- injectWithKey
sourceType:
type: string
enum:
- journey
- step
- block
source:
type: string
target:
type: string
required:
- type
- sourceType
- source
- target
additionalProperties: false
logics:
type: array
items:
type: object
properties:
autoGeneratedId:
type: string
conditions:
type: array
items:
type: string
actions:
type: array
items:
type: string
required:
- conditions
- actions
additionalProperties: false
contextSchema:
type: array
items:
type: object
properties:
type:
type: string
paramKey:
type: string
isRequired:
type: boolean
shouldLoadEntity:
type: boolean
required:
- paramKey
- type
additionalProperties: false
settings:
type: object
properties:
embedOptions:
type: object
properties:
mode:
type: string
enum:
- full-screen
- inline
lang:
type: string
enum:
- de
- en
- fr
width:
type: string
topBar:
type: boolean
scrollToTop:
type: boolean
button:
type: object
properties:
text:
type: string
nullable: true
align:
type: string
enum:
- left
- center
- right
safeModeAutomation:
type: boolean
canary:
type: boolean
designId:
type: string
templateId:
type: string
entityId:
type: string
nullable: true
mappingsAutomationId:
type: string
targetedCustomer:
type: string
description:
type: string
nullable: true
organizationSettings:
type: object
additionalProperties:
type: boolean
nullable: true
publicToken:
type: string
nullable: true
runtimeEntities:
type: array
items:
type: string
enum:
- ORDER
- OPPORTUNITY
filePurposes:
type: array
items:
type: string
entityTags:
type: array
items:
type: string
addressSuggestionsFileUrl:
type: string
nullable: true
deprecated: true
description: "@deprecated Use addressSuggestionsFileId instead"
addressSuggestionsFileId:
type: string
nullable: true
useNewDesign:
type: boolean
accessMode:
type: string
enum:
- PUBLIC
- PRIVATE
isPublished:
type: boolean
status:
type: string
isActive:
type: boolean
savingProgress:
type: object
properties:
savingMode:
type: string
enum:
- auto
- local
- remote
- none
supportedVersion:
type: number
required:
- designId
additionalProperties: false
createdBy:
type: string
__lastModifiedAt:
type: string
description: If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
nullable: true
required:
- organizationId
- name
- steps
additionalProperties: true
JourneyCreationRequestV2:
type: object
properties:
journeyId:
type: string
brandId:
type: string
name:
type: string
steps:
type: array
items:
type: object
additionalProperties: false
properties:
showStepName:
type: boolean
nullable: true
title:
type: string
nullable: true
subTitle:
type: string
nullable: true
showStepSubtitle:
type: boolean
nullable: true
showStepper:
type: boolean
nullable: true
showStepperLabels:
type: boolean
nullable: true
hideNextButton:
type: boolean
nullable: true
name:
type: string
stepId:
type: string
schema: {}
uischema: {}
required:
- name
- schema
- uischema
design:
type: object
properties:
logoUrl:
type: string
nullable: true
theme:
type: object
additionalProperties: {}
additionalProperties: false
rules:
type: array
items:
type: object
properties:
type:
type: string
enum:
- inject
- injectWithKey
sourceType:
type: string
enum:
- journey
- step
- block
source:
type: string
target:
type: string
required:
- type
- sourceType
- source
- target
additionalProperties: false
logics:
type: array
items:
type: object
properties:
autoGeneratedId:
type: string
conditions:
type: array
items:
type: string
actions:
type: array
items:
type: string
required:
- conditions
- actions
additionalProperties: false
contextSchema:
type: array
items:
type: object
properties:
type:
type: string
paramKey:
type: string
isRequired:
type: boolean
shouldLoadEntity:
type: boolean
required:
- paramKey
- type
additionalProperties: false
settings:
type: object
properties:
embedOptions:
type: object
properties:
mode:
type: string
enum:
- full-screen
- inline
lang:
type: string
enum:
- de
- en
- fr
width:
type: string
topBar:
type: boolean
scrollToTop:
type: boolean
button:
type: object
properties:
text:
type: string
nullable: true
align:
type: string
enum:
- left
- center
- right
safeModeAutomation:
type: boolean
designId:
type: string
entityId:
type: string
nullable: true
mappingsAutomationId:
type: string
templateId:
type: string
targetedCustomer:
type: string
description:
type: string
nullable: true
runtimeEntities:
type: array
items:
type: string
enum:
- ORDER
- OPPORTUNITY
filePurposes:
type: array
items:
type: string
entityTags:
type: array
items:
type: string
addressSuggestionsFileUrl:
type: string
nullable: true
deprecated: true
description: "@deprecated Use addressSuggestionsFileId instead"
addressSuggestionsFileId:
type: string
nullable: true
useNewDesign:
type: boolean
accessMode:
type: string
enum:
- PUBLIC
- PRIVATE
additionalProperties: false
_manifest:
type: array
description: Manifest/Blueprint ID used to create/update the entity
items:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
required:
- name
- steps
SearchJourneysQueryRequest:
type: object
properties:
q:
type: string
description: |
Lucene query syntax
See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
example: _tags:*Flex*
default: "*"
from:
type: integer
description: |
The offset of the first result to return.
See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
example: 0
default: 0
size:
type: integer
description: |
The maximum number of results to return.
See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
example: 25
default: 25
sort:
type: string
description: |
The sort order. Follows Lucene syntax.
example: _created_at:desc
default: _created_at:desc
SearchJourneysResponse:
type: object
properties:
hits:
type: number
description: |
The total number of hits.
example: 1
results:
type: array
description: |
The results.
items:
type: object
properties:
_id:
type: string
description: Journey Entity ID
format: uuid
example: e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
_schema:
type: string
description: Entity Schema (journey always in this case)
example: journey
_title:
type: string
description: Journey Entity Title
example: Journey Entity Title
_org:
type: string
description: Organization ID
example: "739224"
_created_at:
type: string
format: date-time
example: "2020-01-01T00:00:00.000Z"
_updated_at:
type: string
format: date-time
example: "2020-01-01T00:00:00.000Z"
_tags:
type: array