-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathenterprise.yaml
1246 lines (1244 loc) · 32.9 KB
/
enterprise.yaml
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.2
info:
title: Shoutout Enterprise Loyalty Admin
version: 1.0.0
description: Shoutout loyalty for enterprises
contact:
name: ShoutOUT Labs
url: 'https://getshoutout.com'
email: [email protected]
servers:
-
url: 'https://api.getshoutout.com/loyaltyservice2'
description: ShoutOUT Loyalty Service
paths:
/rewards:
get:
tags:
- Rewards
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Reward'
examples:
reward response:
value:
-
_id: 5c7cb58fe5cd6a27acff234
name: Reward1
description: description
type: voucher
isRedeemable: true
points: 2500
status: 0
imageUrls:
- 'https://getshoutout.com/casx.jpg'
metadata:
totalCount: 0
usedCount: 0
amountPerRedemption: 0
countPerRedemption: 1
couponResult:
fieldCount: 0
affectedRows: 1
insertId: 0
serverStatus: 2
warningCount: 0
message: ''
protocol41: true
changedRows: 0
ownerId: '43'
createdBy: '43'
createdOn: '2019-02-25T05:09:18.628Z'
description: return rewards as an array
security:
-
APIKey: []
summary: Get rewards
description: Get list of all rewards
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RewardCreate'
examples:
create redeemable voucher reward:
value:
imageUrls:
- >-
https://s3.amazonaws.com/gallery.getshoutout.com/images/43/9656b64d-76e0-4e12-82fc-6fec4c6b0a68.png
name: Reward 2
points: '100'
type: voucher
metadata:
amountPerRedemptionSeasonal: []
amountPerRedemption: 0
dailyRedemptionLimit: -1
userRedeemable: true
required: true
tags:
- Rewards
responses:
'201':
$ref: '#/components/responses/RewardsResponse'
security:
-
APIKey: []
summary: Create reward
description: Create a new reward
'/rewards/{rewardId}':
get:
tags:
- Rewards
responses:
'200':
$ref: '#/components/responses/RewardsResponse'
security:
-
APIKey: []
summary: Get reward
description: Get a reward by reward id
put:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Reward'
required: true
tags:
- Rewards
responses:
'200':
$ref: '#/components/responses/RewardsResponse'
security:
-
APIKey: []
summary: Update reward
description: Update a reward by reward id
delete:
tags:
- Rewards
responses:
'200':
description: empty response
security:
-
APIKey: []
summary: Delete reward
description: Delete a reward by reward id
parameters:
-
name: rewardId
description: reward id
schema:
type: string
in: path
required: true
/products:
summary: 'Get list of products, create a new product'
description: 'Get list of products, create a new product'
get:
tags:
- Products
parameters:
-
examples:
Example skip:
value: '0'
name: skip
description: Number of records to skip
schema:
type: integer
in: query
-
examples:
Example limit:
value: '100'
name: limit
description: Number of records to be returned in the response. Defult is 10
schema:
type: integer
in: query
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Product'
description: products list
security:
-
APIKey: []
summary: Get products
description: Get list of products
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
required: true
tags:
- Products
responses:
'201':
$ref: '#/components/responses/ProductResponse'
security:
-
APIKey: []
summary: Create product
description: Create a new product
'/products/{productId}':
description: 'Get, update and delete a product by id'
get:
tags:
- Products
responses:
'200':
$ref: '#/components/responses/ProductResponse'
security:
-
APIKey: []
summary: Get product
description: Get the product by product id
put:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
required: true
tags:
- Products
responses:
'200':
$ref: '#/components/responses/ProductResponse'
security:
-
APIKey: []
summary: Update product
description: Update the product by product id
delete:
tags:
- Products
responses:
'200':
description: empty response
security:
-
APIKey: []
summary: Delete product
description: Delete the product by product id
parameters:
-
name: productId
description: product id
schema:
type: string
in: path
required: true
/transactions:
get:
tags:
- Transactions
parameters:
-
name: skip
description: Number of transactions to skip. Default is 0
schema:
type: number
in: query
-
name: limit
description: Number of transactions to limit. Default is 10
schema:
type: number
in: query
responses:
'200':
$ref: '#/components/responses/TransactionsResponse'
operationId: getTransactions
summary: Get transactions
description: Get a list of loyalty transactions
/config:
get:
tags:
- Config
responses:
'200':
$ref: '#/components/responses/ConfigurationResponse'
security:
-
APIKey: []
summary: Get configuration
description: Get the current configuration
put:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
required: true
tags:
- Config
responses:
'200':
$ref: '#/components/responses/ConfigurationResponse'
security:
-
APIKey: []
summary: Update configuration
description: >-
Update existing configuration. Can be used to update points, rewards and product based points,
tiers based configurations.
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
required: true
tags:
- Config
responses:
'201':
$ref: '#/components/responses/ConfigurationResponse'
security:
-
APIKey: []
summary: Create configuration
description: Create a new configuration.
delete:
tags:
- Config
responses:
'200':
description: Empty response
security:
-
APIKey: []
summary: Delete configuration
description: Delete current configuration.
/pointscollect:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PointsCollect'
examples:
Collect points for bill value:
value:
userId: some text
activityData:
bill: 47.79
bill_number: some text
employee: some text
location: some text
Collect points for fixed amount:
value:
userId: some text
activityData:
employee: some text
location: some text
points: 45
required: true
tags:
- Points
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PointsCollectResponse'
examples:
Success:
value:
points: 14.22
loyalty_id: some text
total_points: 60.27
tier_points: 7.69
user_type: some text
description: Points collected
security:
-
APIKey: []
operationId: collectPoints
summary: Collect points
description: This method can be used for point collection
/pointsredeem:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PointsRedeem'
examples:
Redeem points:
value:
userId: some text
activityData:
bill_number: some text
employee: some text
location: some text
points: 57.88
required: true
tags:
- Points
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PointsRedeemResponse'
description: Success
security:
-
APIKey: []
summary: Redeem points
description: This method can be used for point redemption
/points:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PointsUpdate'
examples:
Bill points collect example:
value:
userId: some text
activityData:
bill: 19.96
bill_number: some text
employee: some text
location: some text
Direct points collect example:
value:
userId: some text
activityData:
employee: some text
location: some text
points: 17.57
Points redeem example:
value:
userId: some text
activityData:
employee: some text
location: some text
points: 28.94
required: true
tags:
- Points
parameters:
-
name: action
description: |
Point collection or redemption
schema:
enum:
- collect
- redeem
type: string
in: query
required: true
responses:
'200':
$ref: '#/components/responses/PointsUpdateResponse'
deprecated: true
operationId: updatePoints
summary: Collect or redeem points
description: This method can be used for both points earning and redemption
/users:
summary: Customer management
get:
tags:
- Users
parameters:
-
name: skip
description: Number of records to skip
schema:
type: number
in: query
-
name: limit
description: Number of records to be returned in the response. Defult is 10
schema:
type: number
in: query
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomerCreate'
examples:
Example:
value:
-
loyalty_id: some text
name: some text
points: 57.32
tier: some text
tier_points: 77.17
-
loyalty_id: some text
name: some text
points: 56.08
tier: some text
tier_points: 70.6
description: Success
security:
-
APIKey: []
operationId: getUsers
summary: Get users list
description: Get the list of loyalty users.
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCreate'
examples:
Example:
value:
loyalty_id: some text
name: some text
mobile_number: some text
email: some text
required: true
tags:
- Users
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCreate'
examples:
Example:
value:
loyalty_id: some text
name: some text
points: 3.8
tier: some text
tier_points: 30.44
description: Customer created
operationId: createUser
summary: Create user
description: Create customer with pre-defined and user defined attributes
'/users/{loyaltyId}':
get:
tags:
- Users
parameters:
-
name: loyaltyId
description: loyalty id
schema:
type: string
in: path
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCreate'
examples:
Example:
value:
loyalty_id: some text
name: some text
points: 87.68
tier: some text
tier_points: 34.99
description: Success
'404':
description: Customer not found
security:
-
APIKey: []
operationId: getUser
summary: Get user
description: Get a single customer profile via the loyalty id
parameters:
-
name: loyaltyId
description: customer id
schema:
type: string
in: path
required: true
components:
schemas:
Transaction:
description: ''
type: object
properties:
id:
description: ''
type: string
points:
description: ''
type: number
bill:
description: ''
type: number
tier_points:
description: ''
type: number
loyaltyId:
description: ''
type: string
customerId:
description: ''
type: string
billNumber:
description: ''
type: string
Object:
description: JSON type
type: object
example:
imageUrls:
- >-
https://s3.amazonaws.com/gallery.getshoutout.com/images/43/9656b64d-76e0-4e12-82fc-6fec4c6b0a68.png
name: Reward 2
points: 100
type: voucher
metadata:
amountPerRedemptionSeasonal: []
amountPerRedemption: 0
dailyRedemptionLimit: -1
userRedeemable: true
status: 0
Product:
title: Root Type for Product
description: ''
required:
- id
- name
- price
type: object
properties:
id:
description: product id
type: string
name:
description: product name
type: string
price:
description: product price
type: integer
metadata:
$ref: '#/components/schemas/Object'
description: additional metadata
properties:
sku:
type: string
example:
id: product id
name: product name
price: 0
metadata:
sku: some text
PointsUpdateActivityData:
description: ''
required:
- bill
- points
type: object
properties:
bill:
description: Bill amount
type: number
bill_number:
description: Reference number of the bill/invoice
type: string
employee:
description: Name of the employee who entered the bill
type: string
location:
description: Location of the store from where the bill is recorded
type: string
points:
description: Fixed points amount
type: number
example:
bill: 9.13
bill_number: some text
employee: some text
location: some text
points: 31.22
PointsUpdate:
description: ''
required:
- userId
- activityData
type: object
properties:
userId:
description: ''
type: string
activityData:
$ref: '#/components/schemas/PointsUpdateActivityData'
description: ''
example:
userId: some text
activityData:
bill: 38.17
bill_number: some text
employee: some text
location: some text
points: 53.94
PointsUpdateResponse:
description: ''
type: object
properties:
points:
description: ''
type: number
balance_points:
description: ''
type: number
loyalty_id:
description: ''
type: string
RewardCreate:
title: Root Type for Reward
description: ''
required:
- imageUrls
- name
- points
- status
- type
- userRedeemable
type: object
properties:
imageUrls:
description: image urls array
type: array
items:
type: string
name:
description: reward name
type: string
points:
description: number of redeemable points required to redeem the reward
type: integer
type:
description: Reward type
type: string
metadata:
$ref: '#/components/schemas/Object'
properties:
amountPerRedemptionSeasonal:
type: array
items: {}
amountPerRedemption:
format: int32
type: integer
dailyRedemptionLimit:
format: int32
type: integer
userRedeemable:
description: whether user allowed to redeem the reward
type: boolean
status:
description: reward published/ unpublished status
type: integer
example:
imageUrls:
- imageurl1
- imageurl2
name: reward name
points: 0
type: voucher
metadata:
amountPerRedemptionSeasonal: []
amountPerRedemption: 0
dailyRedemptionLimit: -1
userRedeemable: true
status: 0
Reward:
title: Root Type for Reward
description: ''
required:
- _id
- imageUrls
- name
- points
- status
- type
- userRedeemable
type: object
properties:
_id:
description: Reward Id
type: string
imageUrls:
description: list of images
type: array
items:
type: string
name:
description: Reward name
type: string
points:
description: no of redeemable points required to redeem the reward
type: integer
type:
description: Reward type
type: string
metadata:
$ref: '#/components/schemas/Object'
description: additional metadata
properties:
amountPerRedemptionSeasonal:
type: array
items: {}
amountPerRedemption:
format: int32
type: integer
dailyRedemptionLimit:
format: int32
type: integer
userRedeemable:
description: Reward is redeemable or not
type: boolean
status:
format: int32
description: Reward published(1)/Unpublished(0) status
type: integer
example:
_id: reward id
imageUrls:
- imageurl1
- imageurl2
name: reward name
points: 0
type: voucher
metadata:
amountPerRedemptionSeasonal: []
amountPerRedemption: 0
dailyRedemptionLimit: -1
userRedeemable: true
status: 0
Configuration:
title: Root Type for Configuration
description: ''
type: object
properties:
points:
$ref: '#/components/schemas/Object'
description: Points config
properties:
alias:
type: string
custom_purchasePoint:
format: int32
type: integer
merchantBonus:
format: int32
type: integer
minRedeemBalance:
format: int32
type: integer
rate:
format: double
type: number
referralBonus:
format: int32
type: integer
registrationBonus:
format: int32
type: integer
rewards:
$ref: '#/components/schemas/Object'
description: Rewards config
properties:
merchantName:
type: string
portalCoverImageUrl:
type: string
portalImageUrl:
type: string
portalName:
type: string
portalUrl:
type: string
tiers:
$ref: '#/components/schemas/Object'
description: Tier config
properties:
config:
type: object
properties:
calculationWindow:
format: int32
type: integer
immediateTierDowngrade:
type: boolean
immediateTierUpdate:
type: boolean
data:
type: object
properties:
tierId:
type: object
properties:
benefits:
type: array
items:
type: string
imageUrl:
type: string
name:
type: string
points:
format: int32
type: integer
example:
points:
alias: Points
custom_purchasePoint: 0
merchantBonus: 0
minRedeemBalance: 0
rate: 0.002
referralBonus: 0
registrationBonus: 0
rewards:
merchantName: merchant name
portalCoverImageUrl: poratal cover image
portalImageUrl: portal image
portalName: Portal name
portalUrl: portal url
tiers:
config:
calculationWindow: 365
immediateTierDowngrade: true
immediateTierUpdate: true
data:
tierId:
benefits:
- benefit 1
imageUrl: tier image
name: tier name
points: 0
Activity:
description: ''
required:
- activityName
- userId
- activityData
type: object
properties:
userId:
description: ''
type: string
activityName:
description: ''
type: string
activityData:
$ref: '#/components/schemas/Object'
description: ''
example:
userId: some text
activityName: some text
activityData:
param1: val1
param2: val2
Customer:
description: ''
type: object
properties:
loyalty_id:
description: Loyalty id of the customer
type: string
name:
description: Name of the customer
type: string
points:
description: Redeemable loyalty points
type: number
tier:
description: Tier of the customer
type: string
tier_points:
description: Tier points of the customers
type: number
example:
loyalty_id: some text
name: some text
points: 78.85
tier: some text
tier_points: 98.36
CustomerCreate:
description: ''
type: object
properties:
loyalty_id:
description: Loyalty id of the customer
type: string
name:
description: Name of the customer
type: string
mobile_number:
description: ''