@compassdigital/sdk.typescript 4.528.0 → 4.528.1-beta.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.js CHANGED
@@ -6615,6 +6615,379 @@ class ServiceClient extends base_1.BaseServiceClient {
6615
6615
  put_discount_publish(id, body, options) {
6616
6616
  return this.request('discount', '/discount/{id}/publish', 'PUT', `/discount/${id}/publish`, body, options);
6617
6617
  }
6618
+ /**
6619
+ * GET /loyalty/bundles - List bundles with optional filters
6620
+ *
6621
+ * @param options - additional request options
6622
+ */
6623
+ BundleController_findAll(options) {
6624
+ return this.request('loyalty', '/loyalty/bundles', 'GET', `/loyalty/bundles`, null, options);
6625
+ }
6626
+ /**
6627
+ * POST /loyalty/bundles - Create a new bundle
6628
+ *
6629
+ * @param body
6630
+ * @param options - additional request options
6631
+ */
6632
+ BundleController_create(body, options) {
6633
+ return this.request('loyalty', '/loyalty/bundles', 'POST', `/loyalty/bundles`, body, options);
6634
+ }
6635
+ /**
6636
+ * GET /loyalty/bundles/{id} - Get bundle by ID with groups
6637
+ *
6638
+ * @param id
6639
+ * @param options - additional request options
6640
+ */
6641
+ BundleController_findOne(id, options) {
6642
+ return this.request('loyalty', '/loyalty/bundles/{id}', 'GET', `/loyalty/bundles/${id}`, null, options);
6643
+ }
6644
+ /**
6645
+ * PATCH /loyalty/bundles/{id} - Update a bundle
6646
+ *
6647
+ * @param id
6648
+ * @param body
6649
+ * @param options - additional request options
6650
+ */
6651
+ BundleController_update(id, body, options) {
6652
+ return this.request('loyalty', '/loyalty/bundles/{id}', 'PATCH', `/loyalty/bundles/${id}`, body, options);
6653
+ }
6654
+ /**
6655
+ * DELETE /loyalty/bundles/{id} - Soft-delete a bundle
6656
+ *
6657
+ * @param id
6658
+ * @param options - additional request options
6659
+ */
6660
+ BundleController_remove(id, options) {
6661
+ return this.request('loyalty', '/loyalty/bundles/{id}', 'DELETE', `/loyalty/bundles/${id}`, null, options);
6662
+ }
6663
+ /**
6664
+ * GET /loyalty/campaigns - List campaigns with filters and pagination
6665
+ *
6666
+ * @param options - additional request options
6667
+ */
6668
+ CampaignController_list(options) {
6669
+ return this.request('loyalty', '/loyalty/campaigns', 'GET', `/loyalty/campaigns`, null, options);
6670
+ }
6671
+ /**
6672
+ * POST /loyalty/campaigns - Create a campaign with nested child entities
6673
+ *
6674
+ * @param body
6675
+ * @param options - additional request options
6676
+ */
6677
+ CampaignController_create(body, options) {
6678
+ return this.request('loyalty', '/loyalty/campaigns', 'POST', `/loyalty/campaigns`, body, options);
6679
+ }
6680
+ /**
6681
+ * GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
6682
+ *
6683
+ * @param id
6684
+ * @param options - additional request options
6685
+ */
6686
+ CampaignController_findOne(id, options) {
6687
+ return this.request('loyalty', '/loyalty/campaigns/{id}', 'GET', `/loyalty/campaigns/${id}`, null, options);
6688
+ }
6689
+ /**
6690
+ * PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
6691
+ *
6692
+ * @param id
6693
+ * @param body
6694
+ * @param options - additional request options
6695
+ */
6696
+ CampaignController_update(id, body, options) {
6697
+ return this.request('loyalty', '/loyalty/campaigns/{id}', 'PUT', `/loyalty/campaigns/${id}`, body, options);
6698
+ }
6699
+ /**
6700
+ * DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
6701
+ *
6702
+ * @param id
6703
+ * @param options - additional request options
6704
+ */
6705
+ CampaignController_remove(id, options) {
6706
+ return this.request('loyalty', '/loyalty/campaigns/{id}', 'DELETE', `/loyalty/campaigns/${id}`, null, options);
6707
+ }
6708
+ /**
6709
+ * PATCH /loyalty/campaigns/{id}/status - Transition campaign status
6710
+ *
6711
+ * @param id
6712
+ * @param body
6713
+ * @param options - additional request options
6714
+ */
6715
+ CampaignController_updateStatus(id, body, options) {
6716
+ return this.request('loyalty', '/loyalty/campaigns/{id}/status', 'PATCH', `/loyalty/campaigns/${id}/status`, body, options);
6717
+ }
6718
+ /**
6719
+ * POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
6720
+ *
6721
+ * @param id
6722
+ * @param options - additional request options
6723
+ */
6724
+ CampaignController_clone(id, options) {
6725
+ return this.request('loyalty', '/loyalty/campaigns/{id}/clone', 'POST', `/loyalty/campaigns/${id}/clone`, null, options);
6726
+ }
6727
+ /**
6728
+ * GET /loyalty/vouchers - List vouchers with optional filters
6729
+ *
6730
+ * @param options - additional request options
6731
+ */
6732
+ VoucherController_findAll(options) {
6733
+ return this.request('loyalty', '/loyalty/vouchers', 'GET', `/loyalty/vouchers`, null, options);
6734
+ }
6735
+ /**
6736
+ * POST /loyalty/vouchers - Create a single voucher
6737
+ *
6738
+ * @param body
6739
+ * @param options - additional request options
6740
+ */
6741
+ VoucherController_create(body, options) {
6742
+ return this.request('loyalty', '/loyalty/vouchers', 'POST', `/loyalty/vouchers`, body, options);
6743
+ }
6744
+ /**
6745
+ * GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
6746
+ *
6747
+ * @param id
6748
+ * @param options - additional request options
6749
+ */
6750
+ VoucherController_findOne(id, options) {
6751
+ return this.request('loyalty', '/loyalty/vouchers/{id}', 'GET', `/loyalty/vouchers/${id}`, null, options);
6752
+ }
6753
+ /**
6754
+ * PUT /loyalty/vouchers/{id} - Update a voucher
6755
+ *
6756
+ * @param id
6757
+ * @param body
6758
+ * @param options - additional request options
6759
+ */
6760
+ VoucherController_update(id, body, options) {
6761
+ return this.request('loyalty', '/loyalty/vouchers/{id}', 'PUT', `/loyalty/vouchers/${id}`, body, options);
6762
+ }
6763
+ /**
6764
+ * DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
6765
+ *
6766
+ * @param id
6767
+ * @param options - additional request options
6768
+ */
6769
+ VoucherController_remove(id, options) {
6770
+ return this.request('loyalty', '/loyalty/vouchers/{id}', 'DELETE', `/loyalty/vouchers/${id}`, null, options);
6771
+ }
6772
+ /**
6773
+ * POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
6774
+ *
6775
+ * @param id
6776
+ * @param body
6777
+ * @param options - additional request options
6778
+ */
6779
+ VoucherController_revoke(id, body, options) {
6780
+ return this.request('loyalty', '/loyalty/vouchers/{id}/revoke', 'POST', `/loyalty/vouchers/${id}/revoke`, body, options);
6781
+ }
6782
+ /**
6783
+ * POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
6784
+ *
6785
+ * @param body
6786
+ * @param options - additional request options
6787
+ */
6788
+ VoucherController_batchGenerate(body, options) {
6789
+ return this.request('loyalty', '/loyalty/vouchers/batch', 'POST', `/loyalty/vouchers/batch`, body, options);
6790
+ }
6791
+ /**
6792
+ * GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
6793
+ *
6794
+ * @param id
6795
+ * @param options - additional request options
6796
+ */
6797
+ VoucherController_findRedemptions(id, options) {
6798
+ return this.request('loyalty', '/loyalty/vouchers/{id}/redemptions', 'GET', `/loyalty/vouchers/${id}/redemptions`, null, options);
6799
+ }
6800
+ /**
6801
+ * POST /loyalty/vouchers/validate - Validate a voucher code (stub)
6802
+ *
6803
+ * @param options - additional request options
6804
+ */
6805
+ VoucherController_validate(options) {
6806
+ return this.request('loyalty', '/loyalty/vouchers/validate', 'POST', `/loyalty/vouchers/validate`, null, options);
6807
+ }
6808
+ /**
6809
+ * POST /loyalty/vouchers/redeem - Redeem a voucher code (stub)
6810
+ *
6811
+ * @param options - additional request options
6812
+ */
6813
+ VoucherController_redeem(options) {
6814
+ return this.request('loyalty', '/loyalty/vouchers/redeem', 'POST', `/loyalty/vouchers/redeem`, null, options);
6815
+ }
6816
+ /**
6817
+ * GET /loyalty/segments - List segments with optional filters
6818
+ *
6819
+ * @param options - additional request options
6820
+ */
6821
+ SegmentController_findAll(options) {
6822
+ return this.request('loyalty', '/loyalty/segments', 'GET', `/loyalty/segments`, null, options);
6823
+ }
6824
+ /**
6825
+ * POST /loyalty/segments - Create a new segment
6826
+ *
6827
+ * @param body
6828
+ * @param options - additional request options
6829
+ */
6830
+ SegmentController_create(body, options) {
6831
+ return this.request('loyalty', '/loyalty/segments', 'POST', `/loyalty/segments`, body, options);
6832
+ }
6833
+ /**
6834
+ * GET /loyalty/segments/attributes - List available attributes for rule-based segments
6835
+ *
6836
+ * @param options - additional request options
6837
+ */
6838
+ SegmentController_getAttributes(options) {
6839
+ return this.request('loyalty', '/loyalty/segments/attributes', 'GET', `/loyalty/segments/attributes`, null, options);
6840
+ }
6841
+ /**
6842
+ * POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
6843
+ *
6844
+ * @param options - additional request options
6845
+ */
6846
+ SegmentController_previewRuleCount(options) {
6847
+ return this.request('loyalty', '/loyalty/segments/preview-count', 'POST', `/loyalty/segments/preview-count`, null, options);
6848
+ }
6849
+ /**
6850
+ * GET /loyalty/segments/{id} - Get segment by ID
6851
+ *
6852
+ * @param id
6853
+ * @param options - additional request options
6854
+ */
6855
+ SegmentController_findOne(id, options) {
6856
+ return this.request('loyalty', '/loyalty/segments/{id}', 'GET', `/loyalty/segments/${id}`, null, options);
6857
+ }
6858
+ /**
6859
+ * PATCH /loyalty/segments/{id} - Update a segment
6860
+ *
6861
+ * @param id
6862
+ * @param body
6863
+ * @param options - additional request options
6864
+ */
6865
+ SegmentController_update(id, body, options) {
6866
+ return this.request('loyalty', '/loyalty/segments/{id}', 'PATCH', `/loyalty/segments/${id}`, body, options);
6867
+ }
6868
+ /**
6869
+ * DELETE /loyalty/segments/{id} - Soft-delete a segment
6870
+ *
6871
+ * @param id
6872
+ * @param options - additional request options
6873
+ */
6874
+ SegmentController_remove(id, options) {
6875
+ return this.request('loyalty', '/loyalty/segments/{id}', 'DELETE', `/loyalty/segments/${id}`, null, options);
6876
+ }
6877
+ /**
6878
+ * GET /loyalty/segments/{id}/members - List members of a static_list segment
6879
+ *
6880
+ * @param id
6881
+ * @param options - additional request options
6882
+ */
6883
+ SegmentController_findMembers(id, options) {
6884
+ return this.request('loyalty', '/loyalty/segments/{id}/members', 'GET', `/loyalty/segments/${id}/members`, null, options);
6885
+ }
6886
+ /**
6887
+ * POST /loyalty/segments/{id}/members - Add members to a segment
6888
+ *
6889
+ * @param id
6890
+ * @param body
6891
+ * @param options - additional request options
6892
+ */
6893
+ SegmentController_addMembers(id, body, options) {
6894
+ return this.request('loyalty', '/loyalty/segments/{id}/members', 'POST', `/loyalty/segments/${id}/members`, body, options);
6895
+ }
6896
+ /**
6897
+ * DELETE /loyalty/segments/{id}/members - Remove members from a segment
6898
+ *
6899
+ * @param id
6900
+ * @param body
6901
+ * @param options - additional request options
6902
+ */
6903
+ SegmentController_removeMembers(id, body, options) {
6904
+ return this.request('loyalty', '/loyalty/segments/{id}/members', 'DELETE', `/loyalty/segments/${id}/members`, body, options);
6905
+ }
6906
+ /**
6907
+ * POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
6908
+ *
6909
+ * @param id
6910
+ * @param body
6911
+ * @param options - additional request options
6912
+ */
6913
+ RedemptionController_rollback(id, body, options) {
6914
+ return this.request('loyalty', '/loyalty/redemptions/{id}/rollback', 'POST', `/loyalty/redemptions/${id}/rollback`, body, options);
6915
+ }
6916
+ /**
6917
+ * GET /loyalty/loyalty/programs - List loyalty programs with filters and pagination
6918
+ *
6919
+ * @param options - additional request options
6920
+ */
6921
+ LoyaltyController_listPrograms(options) {
6922
+ return this.request('loyalty', '/loyalty/loyalty/programs', 'GET', `/loyalty/loyalty/programs`, null, options);
6923
+ }
6924
+ /**
6925
+ * POST /loyalty/loyalty/programs - Create a loyalty program with earning rules and milestones
6926
+ *
6927
+ * @param body
6928
+ * @param options - additional request options
6929
+ */
6930
+ LoyaltyController_createProgram(body, options) {
6931
+ return this.request('loyalty', '/loyalty/loyalty/programs', 'POST', `/loyalty/loyalty/programs`, body, options);
6932
+ }
6933
+ /**
6934
+ * GET /loyalty/loyalty/programs/{id} - Get loyalty program detail with earning rules and milestones
6935
+ *
6936
+ * @param id
6937
+ * @param options - additional request options
6938
+ */
6939
+ LoyaltyController_findOneProgram(id, options) {
6940
+ return this.request('loyalty', '/loyalty/loyalty/programs/{id}', 'GET', `/loyalty/loyalty/programs/${id}`, null, options);
6941
+ }
6942
+ /**
6943
+ * PUT /loyalty/loyalty/programs/{id} - Update a loyalty program and replace its earning rules and milestones
6944
+ *
6945
+ * @param id
6946
+ * @param body
6947
+ * @param options - additional request options
6948
+ */
6949
+ LoyaltyController_updateProgram(id, body, options) {
6950
+ return this.request('loyalty', '/loyalty/loyalty/programs/{id}', 'PUT', `/loyalty/loyalty/programs/${id}`, body, options);
6951
+ }
6952
+ /**
6953
+ * PATCH /loyalty/loyalty/programs/{id}/status - Transition loyalty program status
6954
+ *
6955
+ * @param id
6956
+ * @param body
6957
+ * @param options - additional request options
6958
+ */
6959
+ LoyaltyController_updateProgramStatus(id, body, options) {
6960
+ return this.request('loyalty', '/loyalty/loyalty/programs/{id}/status', 'PATCH', `/loyalty/loyalty/programs/${id}/status`, body, options);
6961
+ }
6962
+ /**
6963
+ * GET /loyalty/loyalty/programs/{id}/cards - List enrolled customer cards for a program
6964
+ *
6965
+ * @param id
6966
+ * @param options - additional request options
6967
+ */
6968
+ LoyaltyController_listCards(id, options) {
6969
+ return this.request('loyalty', '/loyalty/loyalty/programs/{id}/cards', 'GET', `/loyalty/loyalty/programs/${id}/cards`, null, options);
6970
+ }
6971
+ /**
6972
+ * GET /loyalty/loyalty/programs/{id}/cards/{customerId} - Get card detail with transaction event history
6973
+ *
6974
+ * @param id
6975
+ * @param customerId
6976
+ * @param options - additional request options
6977
+ */
6978
+ LoyaltyController_findCard(id, customerId, options) {
6979
+ return this.request('loyalty', '/loyalty/loyalty/programs/{id}/cards/{customerId}', 'GET', `/loyalty/loyalty/programs/${id}/cards/${customerId}`, null, options);
6980
+ }
6981
+ /**
6982
+ * POST /loyalty/loyalty/cards/{cardId}/adjust - Manual point adjustment on a loyalty card
6983
+ *
6984
+ * @param cardId
6985
+ * @param body
6986
+ * @param options - additional request options
6987
+ */
6988
+ LoyaltyController_adjustPoints(cardId, body, options) {
6989
+ return this.request('loyalty', '/loyalty/loyalty/cards/{cardId}/adjust', 'POST', `/loyalty/loyalty/cards/${cardId}/adjust`, body, options);
6990
+ }
6618
6991
  /**
6619
6992
  * GET /timeslots/brand/{brandId} - Get timeslots for brand
6620
6993
  *