@compassdigital/sdk.typescript 4.527.0 → 4.528.1-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +378 -8
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +452 -3
- package/lib/index.js.map +1 -1
- package/lib/interface/centricos.d.ts +9 -3
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/consumer.d.ts +36 -1
- package/lib/interface/consumer.d.ts.map +1 -1
- package/lib/interface/location.d.ts +0 -1
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/loyalty.d.ts +830 -0
- package/lib/interface/loyalty.d.ts.map +1 -0
- package/lib/interface/loyalty.js +5 -0
- package/lib/interface/loyalty.js.map +1 -0
- package/lib/interface/menu.d.ts +59 -0
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/user.d.ts +20 -0
- package/lib/interface/user.d.ts.map +1 -1
- package/lib/messages/events/AuditEvent.d.ts +39 -0
- package/lib/messages/events/AuditEvent.d.ts.map +1 -0
- package/lib/messages/events/AuditEvent.js +4 -0
- package/lib/messages/events/AuditEvent.js.map +1 -0
- package/lib/messages/events/DiscountCreatedEvent.d.ts +1 -0
- package/lib/messages/events/DiscountCreatedEvent.d.ts.map +1 -1
- package/lib/messages/events/DiscountPublishedEvent.d.ts +1 -0
- package/lib/messages/events/DiscountPublishedEvent.d.ts.map +1 -1
- package/lib/messages/events/DiscountUpdatedEvent.d.ts +1 -0
- package/lib/messages/events/DiscountUpdatedEvent.d.ts.map +1 -1
- package/lib/messages/events/FrictionlessOrderFailureEvent.d.ts +23 -0
- package/lib/messages/events/FrictionlessOrderFailureEvent.d.ts.map +1 -0
- package/lib/messages/events/FrictionlessOrderFailureEvent.js +4 -0
- package/lib/messages/events/FrictionlessOrderFailureEvent.js.map +1 -0
- package/lib/messages/events/index.d.ts +2 -0
- package/lib/messages/events/index.d.ts.map +1 -1
- package/manifest.json +7 -0
- package/package.json +1 -1
- package/src/index.ts +1096 -7
- package/src/interface/centricos.ts +16 -6
- package/src/interface/consumer.ts +59 -1
- package/src/interface/location.ts +0 -1
- package/src/interface/loyalty.ts +1155 -0
- package/src/interface/menu.ts +81 -0
- package/src/interface/user.ts +27 -0
- package/src/messages/events/AuditEvent.ts +52 -0
- package/src/messages/events/DiscountCreatedEvent.ts +1 -0
- package/src/messages/events/DiscountPublishedEvent.ts +1 -0
- package/src/messages/events/DiscountUpdatedEvent.ts +1 -0
- package/src/messages/events/FrictionlessOrderFailureEvent.ts +34 -0
- package/src/messages/events/index.ts +4 -0
- package/test/client.test.ts +23 -0
package/lib/index.js
CHANGED
|
@@ -2071,6 +2071,14 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
2071
2071
|
get_user_ping(options) {
|
|
2072
2072
|
return this.request('user', '/user/ping', 'GET', `/user/ping`, null, options);
|
|
2073
2073
|
}
|
|
2074
|
+
/**
|
|
2075
|
+
* GET /user/health - User Service health check with dependency validation
|
|
2076
|
+
*
|
|
2077
|
+
* @param options - additional request options
|
|
2078
|
+
*/
|
|
2079
|
+
get_user_health(options) {
|
|
2080
|
+
return this.request('user', '/user/health', 'GET', `/user/health`, null, options);
|
|
2081
|
+
}
|
|
2074
2082
|
/**
|
|
2075
2083
|
* GET /calendar/{id}
|
|
2076
2084
|
*
|
|
@@ -4131,6 +4139,24 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4131
4139
|
get_menu_v3_menuworks_business_units(options) {
|
|
4132
4140
|
return this.request('menu', '/menu/v3/menuworks/business_units', 'GET', `/menu/v3/menuworks/business_units`, null, options);
|
|
4133
4141
|
}
|
|
4142
|
+
/**
|
|
4143
|
+
* GET /menu/v3/menuworks/business_units/{unit_id}/products
|
|
4144
|
+
*
|
|
4145
|
+
* @param unit_id
|
|
4146
|
+
* @param options - additional request options
|
|
4147
|
+
*/
|
|
4148
|
+
get_menu_v3_menuworks_business_units_products(unit_id, options) {
|
|
4149
|
+
return this.request('menu', '/menu/v3/menuworks/business_units/{unit_id}/products', 'GET', `/menu/v3/menuworks/business_units/${unit_id}/products`, null, options);
|
|
4150
|
+
}
|
|
4151
|
+
/**
|
|
4152
|
+
* POST /menu/v3/menuworks/business_units/{unit_id}/products/sync
|
|
4153
|
+
*
|
|
4154
|
+
* @param unit_id
|
|
4155
|
+
* @param options - additional request options
|
|
4156
|
+
*/
|
|
4157
|
+
post_menu_v3_menuworks_business_units_products_sync(unit_id, options) {
|
|
4158
|
+
return this.request('menu', '/menu/v3/menuworks/business_units/{unit_id}/products/sync', 'POST', `/menu/v3/menuworks/business_units/${unit_id}/products/sync`, null, options);
|
|
4159
|
+
}
|
|
4134
4160
|
/**
|
|
4135
4161
|
* GET /menu/v3/universal-items
|
|
4136
4162
|
*
|
|
@@ -5788,6 +5814,16 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
5788
5814
|
put_consumer_mealplan(mealplanId, body, options) {
|
|
5789
5815
|
return this.request('consumer', '/consumer/mealplan/{mealplanId}', 'PUT', `/consumer/mealplan/${mealplanId}`, body, options);
|
|
5790
5816
|
}
|
|
5817
|
+
/**
|
|
5818
|
+
* DELETE /consumer/mealplan/{mealplanId} - delete mealplan
|
|
5819
|
+
*
|
|
5820
|
+
* @param mealplanId - Mealplan ID
|
|
5821
|
+
* @param body - Delete Mealplan Request Body
|
|
5822
|
+
* @param options - additional request options
|
|
5823
|
+
*/
|
|
5824
|
+
delete_mealplan_consumer(mealplanId, body, options) {
|
|
5825
|
+
return this.request('consumer', '/consumer/mealplan/{mealplanId}', 'DELETE', `/consumer/mealplan/${mealplanId}`, body, options);
|
|
5826
|
+
}
|
|
5791
5827
|
/**
|
|
5792
5828
|
* POST /consumer/mealplan/{mealplanId}/verify - Send mealplan verification email
|
|
5793
5829
|
*
|
|
@@ -5985,6 +6021,24 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
5985
6021
|
post_payment_validate_merchant(body, options) {
|
|
5986
6022
|
return this.request('consumer', '/consumer/payment/validate/merchant', 'POST', `/consumer/payment/validate/merchant`, body, options);
|
|
5987
6023
|
}
|
|
6024
|
+
/**
|
|
6025
|
+
* GET /consumer/review/order/{orderId} - Get reviews for order items
|
|
6026
|
+
*
|
|
6027
|
+
* @param orderId
|
|
6028
|
+
* @param options - additional request options
|
|
6029
|
+
*/
|
|
6030
|
+
get_consumer_review_order_items(orderId, options) {
|
|
6031
|
+
return this.request('consumer', '/consumer/review/order/{orderId}', 'GET', `/consumer/review/order/${orderId}`, null, options);
|
|
6032
|
+
}
|
|
6033
|
+
/**
|
|
6034
|
+
* POST /consumer/shoppingcart/bulk - get multiple shopping carts
|
|
6035
|
+
*
|
|
6036
|
+
* @param body - Post Shopping Cart Bulk Request Body
|
|
6037
|
+
* @param options - additional request options
|
|
6038
|
+
*/
|
|
6039
|
+
post_consumer_shoppingcart_bulk(body, options) {
|
|
6040
|
+
return this.request('consumer', '/consumer/shoppingcart/bulk', 'POST', `/consumer/shoppingcart/bulk`, body, options);
|
|
6041
|
+
}
|
|
5988
6042
|
/**
|
|
5989
6043
|
* POST /ai/language/generate - Generate text from a given prompt
|
|
5990
6044
|
*
|
|
@@ -6191,6 +6245,16 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
6191
6245
|
put_centricos_station_integration(station_id, integration_type, options) {
|
|
6192
6246
|
return this.request('centricos', '/centricos/station/{station_id}/integration/{integration_type}', 'PUT', `/centricos/station/${station_id}/integration/${integration_type}`, null, options);
|
|
6193
6247
|
}
|
|
6248
|
+
/**
|
|
6249
|
+
* DELETE /centricos/station/{station_id}/{integration_type} - Delete station integration
|
|
6250
|
+
*
|
|
6251
|
+
* @param station_id - TODO: cannot use CompassLongID as path parameter
|
|
6252
|
+
* @param integration_type
|
|
6253
|
+
* @param options - additional request options
|
|
6254
|
+
*/
|
|
6255
|
+
delete_centricos_station_integration(station_id, integration_type, options) {
|
|
6256
|
+
return this.request('centricos', '/centricos/station/{station_id}/{integration_type}', 'DELETE', `/centricos/station/${station_id}/${integration_type}`, null, options);
|
|
6257
|
+
}
|
|
6194
6258
|
/**
|
|
6195
6259
|
* PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
|
|
6196
6260
|
*
|
|
@@ -6325,12 +6389,13 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
6325
6389
|
return this.request('centricos', '/centricos/swaps/list', 'POST', `/centricos/swaps/list`, body, options);
|
|
6326
6390
|
}
|
|
6327
6391
|
/**
|
|
6328
|
-
* GET /centricos/swaps/details - Get detailed information about a swap recommendation
|
|
6392
|
+
* GET /centricos/swaps/details/{recommendation_id} - Get detailed information about a swap recommendation
|
|
6329
6393
|
*
|
|
6394
|
+
* @param recommendation_id - Unique swap recommendation ID
|
|
6330
6395
|
* @param options - additional request options
|
|
6331
6396
|
*/
|
|
6332
|
-
get_swap_details(options) {
|
|
6333
|
-
return this.request('centricos', '/centricos/swaps/details', 'GET', `/centricos/swaps/details`, null, options);
|
|
6397
|
+
get_swap_details(recommendation_id, options) {
|
|
6398
|
+
return this.request('centricos', '/centricos/swaps/details/{recommendation_id}', 'GET', `/centricos/swaps/details/${recommendation_id}`, null, options);
|
|
6334
6399
|
}
|
|
6335
6400
|
/**
|
|
6336
6401
|
* GET /tax/v1/health-check - Health Check
|
|
@@ -6597,6 +6662,390 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
6597
6662
|
put_discount_publish(id, body, options) {
|
|
6598
6663
|
return this.request('discount', '/discount/{id}/publish', 'PUT', `/discount/${id}/publish`, body, options);
|
|
6599
6664
|
}
|
|
6665
|
+
/**
|
|
6666
|
+
* GET /loyalty/bundles - List bundles with optional filters
|
|
6667
|
+
*
|
|
6668
|
+
* @param options - additional request options
|
|
6669
|
+
*/
|
|
6670
|
+
get_loyalty_bundles(options) {
|
|
6671
|
+
return this.request('loyalty', '/loyalty/bundles', 'GET', `/loyalty/bundles`, null, options);
|
|
6672
|
+
}
|
|
6673
|
+
/**
|
|
6674
|
+
* POST /loyalty/bundles - Create a new bundle
|
|
6675
|
+
*
|
|
6676
|
+
* @param body
|
|
6677
|
+
* @param options - additional request options
|
|
6678
|
+
*/
|
|
6679
|
+
post_loyalty_bundle(body, options) {
|
|
6680
|
+
return this.request('loyalty', '/loyalty/bundles', 'POST', `/loyalty/bundles`, body, options);
|
|
6681
|
+
}
|
|
6682
|
+
/**
|
|
6683
|
+
* GET /loyalty/bundles/{id} - Get bundle by ID with groups
|
|
6684
|
+
*
|
|
6685
|
+
* @param id
|
|
6686
|
+
* @param options - additional request options
|
|
6687
|
+
*/
|
|
6688
|
+
get_loyalty_bundle(id, options) {
|
|
6689
|
+
return this.request('loyalty', '/loyalty/bundles/{id}', 'GET', `/loyalty/bundles/${id}`, null, options);
|
|
6690
|
+
}
|
|
6691
|
+
/**
|
|
6692
|
+
* PATCH /loyalty/bundles/{id} - Update a bundle
|
|
6693
|
+
*
|
|
6694
|
+
* @param id
|
|
6695
|
+
* @param body
|
|
6696
|
+
* @param options - additional request options
|
|
6697
|
+
*/
|
|
6698
|
+
patch_loyalty_bundle(id, body, options) {
|
|
6699
|
+
return this.request('loyalty', '/loyalty/bundles/{id}', 'PATCH', `/loyalty/bundles/${id}`, body, options);
|
|
6700
|
+
}
|
|
6701
|
+
/**
|
|
6702
|
+
* DELETE /loyalty/bundles/{id} - Soft-delete a bundle
|
|
6703
|
+
*
|
|
6704
|
+
* @param id
|
|
6705
|
+
* @param options - additional request options
|
|
6706
|
+
*/
|
|
6707
|
+
delete_loyalty_bundle(id, options) {
|
|
6708
|
+
return this.request('loyalty', '/loyalty/bundles/{id}', 'DELETE', `/loyalty/bundles/${id}`, null, options);
|
|
6709
|
+
}
|
|
6710
|
+
/**
|
|
6711
|
+
* GET /loyalty/campaigns - List campaigns with filters and pagination
|
|
6712
|
+
*
|
|
6713
|
+
* @param options - additional request options
|
|
6714
|
+
*/
|
|
6715
|
+
get_loyalty_campaigns(options) {
|
|
6716
|
+
return this.request('loyalty', '/loyalty/campaigns', 'GET', `/loyalty/campaigns`, null, options);
|
|
6717
|
+
}
|
|
6718
|
+
/**
|
|
6719
|
+
* POST /loyalty/campaigns - Create a campaign with nested child entities
|
|
6720
|
+
*
|
|
6721
|
+
* @param body
|
|
6722
|
+
* @param options - additional request options
|
|
6723
|
+
*/
|
|
6724
|
+
post_loyalty_campaign(body, options) {
|
|
6725
|
+
return this.request('loyalty', '/loyalty/campaigns', 'POST', `/loyalty/campaigns`, body, options);
|
|
6726
|
+
}
|
|
6727
|
+
/**
|
|
6728
|
+
* GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
|
|
6729
|
+
*
|
|
6730
|
+
* @param id
|
|
6731
|
+
* @param options - additional request options
|
|
6732
|
+
*/
|
|
6733
|
+
get_loyalty_campaign(id, options) {
|
|
6734
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}', 'GET', `/loyalty/campaigns/${id}`, null, options);
|
|
6735
|
+
}
|
|
6736
|
+
/**
|
|
6737
|
+
* PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
|
|
6738
|
+
*
|
|
6739
|
+
* @param id
|
|
6740
|
+
* @param body
|
|
6741
|
+
* @param options - additional request options
|
|
6742
|
+
*/
|
|
6743
|
+
put_loyalty_campaign(id, body, options) {
|
|
6744
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}', 'PUT', `/loyalty/campaigns/${id}`, body, options);
|
|
6745
|
+
}
|
|
6746
|
+
/**
|
|
6747
|
+
* DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
|
|
6748
|
+
*
|
|
6749
|
+
* @param id
|
|
6750
|
+
* @param options - additional request options
|
|
6751
|
+
*/
|
|
6752
|
+
delete_loyalty_campaign(id, options) {
|
|
6753
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}', 'DELETE', `/loyalty/campaigns/${id}`, null, options);
|
|
6754
|
+
}
|
|
6755
|
+
/**
|
|
6756
|
+
* PATCH /loyalty/campaigns/{id}/status - Transition campaign status
|
|
6757
|
+
*
|
|
6758
|
+
* @param id
|
|
6759
|
+
* @param body
|
|
6760
|
+
* @param options - additional request options
|
|
6761
|
+
*/
|
|
6762
|
+
patch_loyalty_campaign_status(id, body, options) {
|
|
6763
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}/status', 'PATCH', `/loyalty/campaigns/${id}/status`, body, options);
|
|
6764
|
+
}
|
|
6765
|
+
/**
|
|
6766
|
+
* POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
|
|
6767
|
+
*
|
|
6768
|
+
* @param id
|
|
6769
|
+
* @param options - additional request options
|
|
6770
|
+
*/
|
|
6771
|
+
post_loyalty_campaign_clone(id, options) {
|
|
6772
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}/clone', 'POST', `/loyalty/campaigns/${id}/clone`, null, options);
|
|
6773
|
+
}
|
|
6774
|
+
/**
|
|
6775
|
+
* GET /loyalty/vouchers - List vouchers with optional filters
|
|
6776
|
+
*
|
|
6777
|
+
* @param options - additional request options
|
|
6778
|
+
*/
|
|
6779
|
+
get_loyalty_vouchers(options) {
|
|
6780
|
+
return this.request('loyalty', '/loyalty/vouchers', 'GET', `/loyalty/vouchers`, null, options);
|
|
6781
|
+
}
|
|
6782
|
+
/**
|
|
6783
|
+
* POST /loyalty/vouchers - Create a single voucher
|
|
6784
|
+
*
|
|
6785
|
+
* @param body
|
|
6786
|
+
* @param options - additional request options
|
|
6787
|
+
*/
|
|
6788
|
+
post_loyalty_voucher(body, options) {
|
|
6789
|
+
return this.request('loyalty', '/loyalty/vouchers', 'POST', `/loyalty/vouchers`, body, options);
|
|
6790
|
+
}
|
|
6791
|
+
/**
|
|
6792
|
+
* GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
|
|
6793
|
+
*
|
|
6794
|
+
* @param id
|
|
6795
|
+
* @param options - additional request options
|
|
6796
|
+
*/
|
|
6797
|
+
get_loyalty_voucher(id, options) {
|
|
6798
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}', 'GET', `/loyalty/vouchers/${id}`, null, options);
|
|
6799
|
+
}
|
|
6800
|
+
/**
|
|
6801
|
+
* PUT /loyalty/vouchers/{id} - Update a voucher
|
|
6802
|
+
*
|
|
6803
|
+
* @param id
|
|
6804
|
+
* @param body
|
|
6805
|
+
* @param options - additional request options
|
|
6806
|
+
*/
|
|
6807
|
+
put_loyalty_voucher(id, body, options) {
|
|
6808
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}', 'PUT', `/loyalty/vouchers/${id}`, body, options);
|
|
6809
|
+
}
|
|
6810
|
+
/**
|
|
6811
|
+
* DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
|
|
6812
|
+
*
|
|
6813
|
+
* @param id
|
|
6814
|
+
* @param options - additional request options
|
|
6815
|
+
*/
|
|
6816
|
+
delete_loyalty_voucher(id, options) {
|
|
6817
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}', 'DELETE', `/loyalty/vouchers/${id}`, null, options);
|
|
6818
|
+
}
|
|
6819
|
+
/**
|
|
6820
|
+
* POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
|
|
6821
|
+
*
|
|
6822
|
+
* @param id
|
|
6823
|
+
* @param body
|
|
6824
|
+
* @param options - additional request options
|
|
6825
|
+
*/
|
|
6826
|
+
post_loyalty_voucher_revoke(id, body, options) {
|
|
6827
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}/revoke', 'POST', `/loyalty/vouchers/${id}/revoke`, body, options);
|
|
6828
|
+
}
|
|
6829
|
+
/**
|
|
6830
|
+
* POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
|
|
6831
|
+
*
|
|
6832
|
+
* @param body
|
|
6833
|
+
* @param options - additional request options
|
|
6834
|
+
*/
|
|
6835
|
+
post_loyalty_vouchers_batch(body, options) {
|
|
6836
|
+
return this.request('loyalty', '/loyalty/vouchers/batch', 'POST', `/loyalty/vouchers/batch`, body, options);
|
|
6837
|
+
}
|
|
6838
|
+
/**
|
|
6839
|
+
* GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
|
|
6840
|
+
*
|
|
6841
|
+
* @param id
|
|
6842
|
+
* @param options - additional request options
|
|
6843
|
+
*/
|
|
6844
|
+
get_loyalty_voucher_redemptions(id, options) {
|
|
6845
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}/redemptions', 'GET', `/loyalty/vouchers/${id}/redemptions`, null, options);
|
|
6846
|
+
}
|
|
6847
|
+
/**
|
|
6848
|
+
* POST /loyalty/vouchers/validate - Validate one or more voucher codes
|
|
6849
|
+
*
|
|
6850
|
+
* @param body
|
|
6851
|
+
* @param options - additional request options
|
|
6852
|
+
*/
|
|
6853
|
+
post_loyalty_vouchers_validate(body, options) {
|
|
6854
|
+
return this.request('loyalty', '/loyalty/vouchers/validate', 'POST', `/loyalty/vouchers/validate`, body, options);
|
|
6855
|
+
}
|
|
6856
|
+
/**
|
|
6857
|
+
* POST /loyalty/vouchers/redeem - Redeem one or more voucher codes
|
|
6858
|
+
*
|
|
6859
|
+
* @param body
|
|
6860
|
+
* @param options - additional request options
|
|
6861
|
+
*/
|
|
6862
|
+
post_loyalty_vouchers_redeem(body, options) {
|
|
6863
|
+
return this.request('loyalty', '/loyalty/vouchers/redeem', 'POST', `/loyalty/vouchers/redeem`, body, options);
|
|
6864
|
+
}
|
|
6865
|
+
/**
|
|
6866
|
+
* GET /loyalty/segments - List segments with optional filters
|
|
6867
|
+
*
|
|
6868
|
+
* @param options - additional request options
|
|
6869
|
+
*/
|
|
6870
|
+
get_loyalty_segments(options) {
|
|
6871
|
+
return this.request('loyalty', '/loyalty/segments', 'GET', `/loyalty/segments`, null, options);
|
|
6872
|
+
}
|
|
6873
|
+
/**
|
|
6874
|
+
* POST /loyalty/segments - Create a new segment
|
|
6875
|
+
*
|
|
6876
|
+
* @param body
|
|
6877
|
+
* @param options - additional request options
|
|
6878
|
+
*/
|
|
6879
|
+
post_loyalty_segment(body, options) {
|
|
6880
|
+
return this.request('loyalty', '/loyalty/segments', 'POST', `/loyalty/segments`, body, options);
|
|
6881
|
+
}
|
|
6882
|
+
/**
|
|
6883
|
+
* GET /loyalty/segments/attributes - List available attributes for rule-based segments
|
|
6884
|
+
*
|
|
6885
|
+
* @param options - additional request options
|
|
6886
|
+
*/
|
|
6887
|
+
get_loyalty_segment_attributes(options) {
|
|
6888
|
+
return this.request('loyalty', '/loyalty/segments/attributes', 'GET', `/loyalty/segments/attributes`, null, options);
|
|
6889
|
+
}
|
|
6890
|
+
/**
|
|
6891
|
+
* POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
|
|
6892
|
+
*
|
|
6893
|
+
* @param options - additional request options
|
|
6894
|
+
*/
|
|
6895
|
+
post_loyalty_segment_preview_count(options) {
|
|
6896
|
+
return this.request('loyalty', '/loyalty/segments/preview-count', 'POST', `/loyalty/segments/preview-count`, null, options);
|
|
6897
|
+
}
|
|
6898
|
+
/**
|
|
6899
|
+
* GET /loyalty/segments/{id} - Get segment by ID
|
|
6900
|
+
*
|
|
6901
|
+
* @param id
|
|
6902
|
+
* @param options - additional request options
|
|
6903
|
+
*/
|
|
6904
|
+
get_loyalty_segment(id, options) {
|
|
6905
|
+
return this.request('loyalty', '/loyalty/segments/{id}', 'GET', `/loyalty/segments/${id}`, null, options);
|
|
6906
|
+
}
|
|
6907
|
+
/**
|
|
6908
|
+
* PATCH /loyalty/segments/{id} - Update a segment
|
|
6909
|
+
*
|
|
6910
|
+
* @param id
|
|
6911
|
+
* @param body
|
|
6912
|
+
* @param options - additional request options
|
|
6913
|
+
*/
|
|
6914
|
+
patch_loyalty_segment(id, body, options) {
|
|
6915
|
+
return this.request('loyalty', '/loyalty/segments/{id}', 'PATCH', `/loyalty/segments/${id}`, body, options);
|
|
6916
|
+
}
|
|
6917
|
+
/**
|
|
6918
|
+
* DELETE /loyalty/segments/{id} - Soft-delete a segment
|
|
6919
|
+
*
|
|
6920
|
+
* @param id
|
|
6921
|
+
* @param options - additional request options
|
|
6922
|
+
*/
|
|
6923
|
+
delete_loyalty_segment(id, options) {
|
|
6924
|
+
return this.request('loyalty', '/loyalty/segments/{id}', 'DELETE', `/loyalty/segments/${id}`, null, options);
|
|
6925
|
+
}
|
|
6926
|
+
/**
|
|
6927
|
+
* GET /loyalty/segments/{id}/members - List members of a static_list segment
|
|
6928
|
+
*
|
|
6929
|
+
* @param id
|
|
6930
|
+
* @param options - additional request options
|
|
6931
|
+
*/
|
|
6932
|
+
get_loyalty_segment_members(id, options) {
|
|
6933
|
+
return this.request('loyalty', '/loyalty/segments/{id}/members', 'GET', `/loyalty/segments/${id}/members`, null, options);
|
|
6934
|
+
}
|
|
6935
|
+
/**
|
|
6936
|
+
* POST /loyalty/segments/{id}/members - Add members to a segment
|
|
6937
|
+
*
|
|
6938
|
+
* @param id
|
|
6939
|
+
* @param body
|
|
6940
|
+
* @param options - additional request options
|
|
6941
|
+
*/
|
|
6942
|
+
post_loyalty_segment_members(id, body, options) {
|
|
6943
|
+
return this.request('loyalty', '/loyalty/segments/{id}/members', 'POST', `/loyalty/segments/${id}/members`, body, options);
|
|
6944
|
+
}
|
|
6945
|
+
/**
|
|
6946
|
+
* DELETE /loyalty/segments/{id}/members - Remove members from a segment
|
|
6947
|
+
*
|
|
6948
|
+
* @param id
|
|
6949
|
+
* @param body
|
|
6950
|
+
* @param options - additional request options
|
|
6951
|
+
*/
|
|
6952
|
+
delete_loyalty_segment_members(id, body, options) {
|
|
6953
|
+
return this.request('loyalty', '/loyalty/segments/{id}/members', 'DELETE', `/loyalty/segments/${id}/members`, body, options);
|
|
6954
|
+
}
|
|
6955
|
+
/**
|
|
6956
|
+
* POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
|
|
6957
|
+
*
|
|
6958
|
+
* @param id
|
|
6959
|
+
* @param body
|
|
6960
|
+
* @param options - additional request options
|
|
6961
|
+
*/
|
|
6962
|
+
post_loyalty_redemption_rollback(id, body, options) {
|
|
6963
|
+
return this.request('loyalty', '/loyalty/redemptions/{id}/rollback', 'POST', `/loyalty/redemptions/${id}/rollback`, body, options);
|
|
6964
|
+
}
|
|
6965
|
+
/**
|
|
6966
|
+
* GET /loyalty/rewards - List rewards with filters and pagination
|
|
6967
|
+
*
|
|
6968
|
+
* @param options - additional request options
|
|
6969
|
+
*/
|
|
6970
|
+
get_loyalty_rewards(options) {
|
|
6971
|
+
return this.request('loyalty', '/loyalty/rewards', 'GET', `/loyalty/rewards`, null, options);
|
|
6972
|
+
}
|
|
6973
|
+
/**
|
|
6974
|
+
* POST /loyalty/rewards - Create a reward with earning rules and milestones
|
|
6975
|
+
*
|
|
6976
|
+
* @param body
|
|
6977
|
+
* @param options - additional request options
|
|
6978
|
+
*/
|
|
6979
|
+
post_loyalty_reward(body, options) {
|
|
6980
|
+
return this.request('loyalty', '/loyalty/rewards', 'POST', `/loyalty/rewards`, body, options);
|
|
6981
|
+
}
|
|
6982
|
+
/**
|
|
6983
|
+
* GET /loyalty/rewards/{id} - Get reward detail with earning rules and milestones
|
|
6984
|
+
*
|
|
6985
|
+
* @param id
|
|
6986
|
+
* @param options - additional request options
|
|
6987
|
+
*/
|
|
6988
|
+
get_loyalty_reward(id, options) {
|
|
6989
|
+
return this.request('loyalty', '/loyalty/rewards/{id}', 'GET', `/loyalty/rewards/${id}`, null, options);
|
|
6990
|
+
}
|
|
6991
|
+
/**
|
|
6992
|
+
* PUT /loyalty/rewards/{id} - Update a reward and replace its earning rules and milestones
|
|
6993
|
+
*
|
|
6994
|
+
* @param id
|
|
6995
|
+
* @param body
|
|
6996
|
+
* @param options - additional request options
|
|
6997
|
+
*/
|
|
6998
|
+
put_loyalty_reward(id, body, options) {
|
|
6999
|
+
return this.request('loyalty', '/loyalty/rewards/{id}', 'PUT', `/loyalty/rewards/${id}`, body, options);
|
|
7000
|
+
}
|
|
7001
|
+
/**
|
|
7002
|
+
* PATCH /loyalty/rewards/{id}/status - Transition reward status
|
|
7003
|
+
*
|
|
7004
|
+
* @param id
|
|
7005
|
+
* @param body
|
|
7006
|
+
* @param options - additional request options
|
|
7007
|
+
*/
|
|
7008
|
+
patch_loyalty_reward_status(id, body, options) {
|
|
7009
|
+
return this.request('loyalty', '/loyalty/rewards/{id}/status', 'PATCH', `/loyalty/rewards/${id}/status`, body, options);
|
|
7010
|
+
}
|
|
7011
|
+
/**
|
|
7012
|
+
* GET /loyalty/rewards/{id}/cards - List enrolled customer cards for a reward
|
|
7013
|
+
*
|
|
7014
|
+
* @param id
|
|
7015
|
+
* @param options - additional request options
|
|
7016
|
+
*/
|
|
7017
|
+
get_loyalty_reward_cards(id, options) {
|
|
7018
|
+
return this.request('loyalty', '/loyalty/rewards/{id}/cards', 'GET', `/loyalty/rewards/${id}/cards`, null, options);
|
|
7019
|
+
}
|
|
7020
|
+
/**
|
|
7021
|
+
* GET /loyalty/rewards/{id}/cards/{customerId} - Get card detail with transaction event history
|
|
7022
|
+
*
|
|
7023
|
+
* @param id
|
|
7024
|
+
* @param customerId
|
|
7025
|
+
* @param options - additional request options
|
|
7026
|
+
*/
|
|
7027
|
+
get_loyalty_reward_card(id, customerId, options) {
|
|
7028
|
+
return this.request('loyalty', '/loyalty/rewards/{id}/cards/{customerId}', 'GET', `/loyalty/rewards/${id}/cards/${customerId}`, null, options);
|
|
7029
|
+
}
|
|
7030
|
+
/**
|
|
7031
|
+
* POST /loyalty/rewards/cards/{cardId}/adjust - Manual point adjustment on a reward card
|
|
7032
|
+
*
|
|
7033
|
+
* @param cardId
|
|
7034
|
+
* @param body
|
|
7035
|
+
* @param options - additional request options
|
|
7036
|
+
*/
|
|
7037
|
+
post_loyalty_reward_card_adjust(cardId, body, options) {
|
|
7038
|
+
return this.request('loyalty', '/loyalty/rewards/cards/{cardId}/adjust', 'POST', `/loyalty/rewards/cards/${cardId}/adjust`, body, options);
|
|
7039
|
+
}
|
|
7040
|
+
/**
|
|
7041
|
+
* POST /loyalty/rewards/orders/earn - Evaluate an order against active reward rules and award points idempotently
|
|
7042
|
+
*
|
|
7043
|
+
* @param body
|
|
7044
|
+
* @param options - additional request options
|
|
7045
|
+
*/
|
|
7046
|
+
post_loyalty_reward_order_earn(body, options) {
|
|
7047
|
+
return this.request('loyalty', '/loyalty/rewards/orders/earn', 'POST', `/loyalty/rewards/orders/earn`, body, options);
|
|
7048
|
+
}
|
|
6600
7049
|
/**
|
|
6601
7050
|
* GET /timeslots/brand/{brandId} - Get timeslots for brand
|
|
6602
7051
|
*
|