@compassdigital/sdk.typescript 4.108.0 → 4.109.0
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 +49 -51
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +54 -53
- package/lib/index.js.map +1 -1
- package/lib/interface/auth.d.ts +5 -0
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/centricos.d.ts +100 -53
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/discount.d.ts +25 -13
- package/lib/interface/discount.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +14 -2
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/promo.d.ts +59 -0
- package/lib/interface/promo.d.ts.map +1 -1
- package/lib/interface/search.d.ts +7 -2
- package/lib/interface/search.d.ts.map +1 -1
- package/lib/interface/user.d.ts +10 -1
- package/lib/interface/user.d.ts.map +1 -1
- package/manifest.json +4 -4
- package/package.json +1 -1
- package/src/index.ts +128 -126
- package/src/interface/auth.ts +6 -0
- package/src/interface/centricos.ts +165 -62
- package/src/interface/discount.ts +32 -14
- package/src/interface/menu.ts +14 -2
- package/src/interface/promo.ts +73 -0
- package/src/interface/search.ts +8 -2
- package/src/interface/user.ts +14 -2
package/lib/index.js
CHANGED
|
@@ -1269,6 +1269,15 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
1269
1269
|
post_promo_validate_voucher(body, options) {
|
|
1270
1270
|
return this.request('promo', '/promo/validate/voucher', 'post', `/promo/validate/voucher`, body, options);
|
|
1271
1271
|
}
|
|
1272
|
+
/**
|
|
1273
|
+
* POST /promo/validate/vouchers - Validate multiple promo vouchers
|
|
1274
|
+
*
|
|
1275
|
+
* @param body
|
|
1276
|
+
* @param options - additional request options
|
|
1277
|
+
*/
|
|
1278
|
+
post_promo_validate_vouchers(body, options) {
|
|
1279
|
+
return this.request('promo', '/promo/validate/vouchers', 'post', `/promo/validate/vouchers`, body, options);
|
|
1280
|
+
}
|
|
1272
1281
|
/**
|
|
1273
1282
|
* POST /promo/redeem/voucher - Redeem a promo voucher
|
|
1274
1283
|
*
|
|
@@ -1278,6 +1287,15 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
1278
1287
|
post_promo_redeem_voucher(body, options) {
|
|
1279
1288
|
return this.request('promo', '/promo/redeem/voucher', 'post', `/promo/redeem/voucher`, body, options);
|
|
1280
1289
|
}
|
|
1290
|
+
/**
|
|
1291
|
+
* POST /promo/redeem/vouchers - Redeem multiple promo vouchers
|
|
1292
|
+
*
|
|
1293
|
+
* @param body
|
|
1294
|
+
* @param options - additional request options
|
|
1295
|
+
*/
|
|
1296
|
+
post_promo_redeem_vouchers(body, options) {
|
|
1297
|
+
return this.request('promo', '/promo/redeem/vouchers', 'post', `/promo/redeem/vouchers`, body, options);
|
|
1298
|
+
}
|
|
1281
1299
|
/**
|
|
1282
1300
|
* POST /promo/voucher - Create new voucher
|
|
1283
1301
|
*
|
|
@@ -4653,49 +4671,6 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4653
4671
|
post_frictionless_amazon_jwo_connector_v1_order_purchases(body, options) {
|
|
4654
4672
|
return this.request('frictionless', '/frictionless/amazon-jwo-connector/v1/order/purchases', 'post', `/frictionless/amazon-jwo-connector/v1/order/purchases`, body, options);
|
|
4655
4673
|
}
|
|
4656
|
-
/**
|
|
4657
|
-
* GET /consumer/v1/health-check
|
|
4658
|
-
*
|
|
4659
|
-
* @param options - additional request options
|
|
4660
|
-
*/
|
|
4661
|
-
HealthCheckController_execute(options) {
|
|
4662
|
-
return this.request('consumer', '/consumer/v1/health-check', 'get', `/consumer/v1/health-check`, null, options);
|
|
4663
|
-
}
|
|
4664
|
-
/**
|
|
4665
|
-
* GET /consumer/v1/payment-methods - List payment methods available in a given brand
|
|
4666
|
-
*
|
|
4667
|
-
* @param options - additional request options
|
|
4668
|
-
*/
|
|
4669
|
-
get_payment_list_by_brand(options) {
|
|
4670
|
-
return this.request('consumer', '/consumer/v1/payment-methods', 'get', `/consumer/v1/payment-methods`, null, options);
|
|
4671
|
-
}
|
|
4672
|
-
/**
|
|
4673
|
-
* GET /consumer/customer-orders/{userId} - Get customer orders
|
|
4674
|
-
*
|
|
4675
|
-
* @param userId - a valid CDL user id
|
|
4676
|
-
* @param options - additional request options
|
|
4677
|
-
*/
|
|
4678
|
-
get_customer_orders(userId, options) {
|
|
4679
|
-
return this.request('consumer', '/consumer/customer-orders/{userId}', 'get', `/consumer/customer-orders/${userId}`, null, options);
|
|
4680
|
-
}
|
|
4681
|
-
/**
|
|
4682
|
-
* POST /consumer/review/order-items - Submit reviews for order items
|
|
4683
|
-
*
|
|
4684
|
-
* @param body
|
|
4685
|
-
* @param options - additional request options
|
|
4686
|
-
*/
|
|
4687
|
-
post_review_order_items(body, options) {
|
|
4688
|
-
return this.request('consumer', '/consumer/review/order-items', 'post', `/consumer/review/order-items`, body, options);
|
|
4689
|
-
}
|
|
4690
|
-
/**
|
|
4691
|
-
* POST /consumer/home - Provide the front end all the data required to render the home page
|
|
4692
|
-
*
|
|
4693
|
-
* @param body
|
|
4694
|
-
* @param options - additional request options
|
|
4695
|
-
*/
|
|
4696
|
-
post_home_page(body, options) {
|
|
4697
|
-
return this.request('consumer', '/consumer/home', 'post', `/consumer/home`, body, options);
|
|
4698
|
-
}
|
|
4699
4674
|
/**
|
|
4700
4675
|
* POST /ai/language/generate - Generate text from a given prompt
|
|
4701
4676
|
*
|
|
@@ -4752,7 +4727,7 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4752
4727
|
/**
|
|
4753
4728
|
* GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in site's local timezone.
|
|
4754
4729
|
*
|
|
4755
|
-
* @param location_group - TODO:
|
|
4730
|
+
* @param location_group - TODO: cannot use CompassLongID as path parameter
|
|
4756
4731
|
* @param options - additional request options
|
|
4757
4732
|
*/
|
|
4758
4733
|
get_centricos_report_group_config(location_group, options) {
|
|
@@ -4761,7 +4736,7 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4761
4736
|
/**
|
|
4762
4737
|
* PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in site's local timezone.
|
|
4763
4738
|
*
|
|
4764
|
-
* @param location_group - TODO:
|
|
4739
|
+
* @param location_group - TODO: cannot use CompassLongID as path parameter
|
|
4765
4740
|
* @param body
|
|
4766
4741
|
* @param options - additional request options
|
|
4767
4742
|
*/
|
|
@@ -4771,7 +4746,7 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4771
4746
|
/**
|
|
4772
4747
|
* DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group. Times are in site's local timezone.
|
|
4773
4748
|
*
|
|
4774
|
-
* @param location_group - TODO:
|
|
4749
|
+
* @param location_group - TODO: cannot use CompassLongID as path parameter
|
|
4775
4750
|
* @param options - additional request options
|
|
4776
4751
|
*/
|
|
4777
4752
|
delete_centricos_report_group_config(location_group, options) {
|
|
@@ -4780,7 +4755,7 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4780
4755
|
/**
|
|
4781
4756
|
* GET /centricos/report/group/{location_group}/config/default - Get default report configuration. Times are in site's local timezone.
|
|
4782
4757
|
*
|
|
4783
|
-
* @param location_group - TODO:
|
|
4758
|
+
* @param location_group - TODO: cannot use CompassLongID as path parameter
|
|
4784
4759
|
* @param options - additional request options
|
|
4785
4760
|
*/
|
|
4786
4761
|
get_centricos_report_config_default(location_group, options) {
|
|
@@ -4811,6 +4786,15 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4811
4786
|
get_centricos_sites(options) {
|
|
4812
4787
|
return this.request('centricos', '/centricos/sites', 'get', `/centricos/sites`, null, options);
|
|
4813
4788
|
}
|
|
4789
|
+
/**
|
|
4790
|
+
* GET /centricos/sites/price-level/{price_level} - This returns specific properties from sites, locations, and stations connected to a menu price level. This does not support pagination, filtering, sorting, or searching.
|
|
4791
|
+
*
|
|
4792
|
+
* @param price_level - TODO: cannot use CompassLongID as path parameter
|
|
4793
|
+
* @param options - additional request options
|
|
4794
|
+
*/
|
|
4795
|
+
get_sites_from_price_level(price_level, options) {
|
|
4796
|
+
return this.request('centricos', '/centricos/sites/price-level/{price_level}', 'get', `/centricos/sites/price-level/${price_level}`, null, options);
|
|
4797
|
+
}
|
|
4814
4798
|
/**
|
|
4815
4799
|
* GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
|
|
4816
4800
|
*
|
|
@@ -4823,7 +4807,7 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4823
4807
|
/**
|
|
4824
4808
|
* GET /centricos/station/{station_id} - Get station details
|
|
4825
4809
|
*
|
|
4826
|
-
* @param station_id - TODO:
|
|
4810
|
+
* @param station_id - TODO: cannot use CompassLongID as path parameter
|
|
4827
4811
|
* @param options - additional request options
|
|
4828
4812
|
*/
|
|
4829
4813
|
get_centricos_station(station_id, options) {
|
|
@@ -4835,18 +4819,35 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4835
4819
|
* @param body
|
|
4836
4820
|
* @param options - additional request options
|
|
4837
4821
|
*/
|
|
4838
|
-
|
|
4822
|
+
put_centricos_discount_voucherify(body, options) {
|
|
4839
4823
|
return this.request('centricos', '/centricos/discount/voucherify', 'put', `/centricos/discount/voucherify`, body, options);
|
|
4840
4824
|
}
|
|
4841
4825
|
/**
|
|
4842
4826
|
* PUT /centricos/discount/{id}/voucherify/publish - Update and publish a voucherify discount and assign it to multiple sites
|
|
4843
4827
|
*
|
|
4844
4828
|
* @param id - Discount ID
|
|
4845
|
-
* @param body
|
|
4846
4829
|
* @param options - additional request options
|
|
4847
4830
|
*/
|
|
4848
|
-
|
|
4849
|
-
return this.request('centricos', '/centricos/discount/{id}/voucherify/publish', 'put', `/centricos/discount/${id}/voucherify/publish`,
|
|
4831
|
+
put_centricos_discount_voucherify_publish(id, options) {
|
|
4832
|
+
return this.request('centricos', '/centricos/discount/{id}/voucherify/publish', 'put', `/centricos/discount/${id}/voucherify/publish`, null, options);
|
|
4833
|
+
}
|
|
4834
|
+
/**
|
|
4835
|
+
* DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
|
|
4836
|
+
*
|
|
4837
|
+
* @param id - Discount ID
|
|
4838
|
+
* @param options - additional request options
|
|
4839
|
+
*/
|
|
4840
|
+
delete_centricos_discounts_voucherify(id, options) {
|
|
4841
|
+
return this.request('centricos', '/centricos/discount/{id}/voucherify', 'delete', `/centricos/discount/${id}/voucherify`, null, options);
|
|
4842
|
+
}
|
|
4843
|
+
/**
|
|
4844
|
+
* GET /centricos/discount/{id} - Get discount information by ID
|
|
4845
|
+
*
|
|
4846
|
+
* @param id - ID of the discount to retrieve
|
|
4847
|
+
* @param options - additional request options
|
|
4848
|
+
*/
|
|
4849
|
+
get_centricos_discount(id, options) {
|
|
4850
|
+
return this.request('centricos', '/centricos/discount/{id}', 'get', `/centricos/discount/${id}`, null, options);
|
|
4850
4851
|
}
|
|
4851
4852
|
/**
|
|
4852
4853
|
* GET /tax/v1/health-check - Health Check
|
|
@@ -4982,7 +4983,7 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
4982
4983
|
/**
|
|
4983
4984
|
* GET /discount/{id} - Get a discount
|
|
4984
4985
|
*
|
|
4985
|
-
* @param id
|
|
4986
|
+
* @param id - a discount id
|
|
4986
4987
|
* @param options - additional request options
|
|
4987
4988
|
*/
|
|
4988
4989
|
get_discount(id, options) {
|