@compassdigital/sdk.typescript 4.598.0 → 4.600.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 +318 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +385 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/loyalty.d.ts +853 -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/manifest.json +7 -0
- package/package.json +1 -1
- package/src/index.ts +945 -0
- package/src/interface/loyalty.ts +1198 -0
- package/test/client.test.ts +23 -0
package/lib/index.js
CHANGED
|
@@ -6865,6 +6865,391 @@ class ServiceClient extends base_1.BaseServiceClient {
|
|
|
6865
6865
|
put_discount_publish(id, body, options) {
|
|
6866
6866
|
return this.request('discount', '/discount/{id}/publish', 'PUT', `/discount/${id}/publish`, body, options);
|
|
6867
6867
|
}
|
|
6868
|
+
/**
|
|
6869
|
+
* GET /loyalty/bundles - List bundles with optional filters
|
|
6870
|
+
*
|
|
6871
|
+
* @param options - additional request options
|
|
6872
|
+
*/
|
|
6873
|
+
get_loyalty_bundles(options) {
|
|
6874
|
+
return this.request('loyalty', '/loyalty/bundles', 'GET', `/loyalty/bundles`, null, options);
|
|
6875
|
+
}
|
|
6876
|
+
/**
|
|
6877
|
+
* POST /loyalty/bundles - Create a new bundle
|
|
6878
|
+
*
|
|
6879
|
+
* @param body
|
|
6880
|
+
* @param options - additional request options
|
|
6881
|
+
*/
|
|
6882
|
+
post_loyalty_bundle(body, options) {
|
|
6883
|
+
return this.request('loyalty', '/loyalty/bundles', 'POST', `/loyalty/bundles`, body, options);
|
|
6884
|
+
}
|
|
6885
|
+
/**
|
|
6886
|
+
* GET /loyalty/bundles/{id} - Get bundle by ID with groups
|
|
6887
|
+
*
|
|
6888
|
+
* @param id
|
|
6889
|
+
* @param options - additional request options
|
|
6890
|
+
*/
|
|
6891
|
+
get_loyalty_bundle(id, options) {
|
|
6892
|
+
return this.request('loyalty', '/loyalty/bundles/{id}', 'GET', `/loyalty/bundles/${id}`, null, options);
|
|
6893
|
+
}
|
|
6894
|
+
/**
|
|
6895
|
+
* PATCH /loyalty/bundles/{id} - Update a bundle
|
|
6896
|
+
*
|
|
6897
|
+
* @param id
|
|
6898
|
+
* @param body
|
|
6899
|
+
* @param options - additional request options
|
|
6900
|
+
*/
|
|
6901
|
+
patch_loyalty_bundle(id, body, options) {
|
|
6902
|
+
return this.request('loyalty', '/loyalty/bundles/{id}', 'PATCH', `/loyalty/bundles/${id}`, body, options);
|
|
6903
|
+
}
|
|
6904
|
+
/**
|
|
6905
|
+
* DELETE /loyalty/bundles/{id} - Soft-delete a bundle
|
|
6906
|
+
*
|
|
6907
|
+
* @param id
|
|
6908
|
+
* @param options - additional request options
|
|
6909
|
+
*/
|
|
6910
|
+
delete_loyalty_bundle(id, options) {
|
|
6911
|
+
return this.request('loyalty', '/loyalty/bundles/{id}', 'DELETE', `/loyalty/bundles/${id}`, null, options);
|
|
6912
|
+
}
|
|
6913
|
+
/**
|
|
6914
|
+
* GET /loyalty/campaigns - List campaigns with filters and pagination
|
|
6915
|
+
*
|
|
6916
|
+
* @param options - additional request options
|
|
6917
|
+
*/
|
|
6918
|
+
get_loyalty_campaigns(options) {
|
|
6919
|
+
return this.request('loyalty', '/loyalty/campaigns', 'GET', `/loyalty/campaigns`, null, options);
|
|
6920
|
+
}
|
|
6921
|
+
/**
|
|
6922
|
+
* POST /loyalty/campaigns - Create a campaign with nested child entities
|
|
6923
|
+
*
|
|
6924
|
+
* @param body
|
|
6925
|
+
* @param options - additional request options
|
|
6926
|
+
*/
|
|
6927
|
+
post_loyalty_campaign(body, options) {
|
|
6928
|
+
return this.request('loyalty', '/loyalty/campaigns', 'POST', `/loyalty/campaigns`, body, options);
|
|
6929
|
+
}
|
|
6930
|
+
/**
|
|
6931
|
+
* GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
|
|
6932
|
+
*
|
|
6933
|
+
* @param id
|
|
6934
|
+
* @param options - additional request options
|
|
6935
|
+
*/
|
|
6936
|
+
get_loyalty_campaign(id, options) {
|
|
6937
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}', 'GET', `/loyalty/campaigns/${id}`, null, options);
|
|
6938
|
+
}
|
|
6939
|
+
/**
|
|
6940
|
+
* PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
|
|
6941
|
+
*
|
|
6942
|
+
* @param id
|
|
6943
|
+
* @param body
|
|
6944
|
+
* @param options - additional request options
|
|
6945
|
+
*/
|
|
6946
|
+
put_loyalty_campaign(id, body, options) {
|
|
6947
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}', 'PUT', `/loyalty/campaigns/${id}`, body, options);
|
|
6948
|
+
}
|
|
6949
|
+
/**
|
|
6950
|
+
* DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
|
|
6951
|
+
*
|
|
6952
|
+
* @param id
|
|
6953
|
+
* @param options - additional request options
|
|
6954
|
+
*/
|
|
6955
|
+
delete_loyalty_campaign(id, options) {
|
|
6956
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}', 'DELETE', `/loyalty/campaigns/${id}`, null, options);
|
|
6957
|
+
}
|
|
6958
|
+
/**
|
|
6959
|
+
* PATCH /loyalty/campaigns/{id}/status - Transition campaign status
|
|
6960
|
+
*
|
|
6961
|
+
* @param id
|
|
6962
|
+
* @param body
|
|
6963
|
+
* @param options - additional request options
|
|
6964
|
+
*/
|
|
6965
|
+
patch_loyalty_campaign_status(id, body, options) {
|
|
6966
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}/status', 'PATCH', `/loyalty/campaigns/${id}/status`, body, options);
|
|
6967
|
+
}
|
|
6968
|
+
/**
|
|
6969
|
+
* POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
|
|
6970
|
+
*
|
|
6971
|
+
* @param id
|
|
6972
|
+
* @param options - additional request options
|
|
6973
|
+
*/
|
|
6974
|
+
post_loyalty_campaign_clone(id, options) {
|
|
6975
|
+
return this.request('loyalty', '/loyalty/campaigns/{id}/clone', 'POST', `/loyalty/campaigns/${id}/clone`, null, options);
|
|
6976
|
+
}
|
|
6977
|
+
/**
|
|
6978
|
+
* GET /loyalty/vouchers - List vouchers with optional filters
|
|
6979
|
+
*
|
|
6980
|
+
* @param options - additional request options
|
|
6981
|
+
*/
|
|
6982
|
+
get_loyalty_vouchers(options) {
|
|
6983
|
+
return this.request('loyalty', '/loyalty/vouchers', 'GET', `/loyalty/vouchers`, null, options);
|
|
6984
|
+
}
|
|
6985
|
+
/**
|
|
6986
|
+
* POST /loyalty/vouchers - Create a single voucher
|
|
6987
|
+
*
|
|
6988
|
+
* @param body
|
|
6989
|
+
* @param options - additional request options
|
|
6990
|
+
*/
|
|
6991
|
+
post_loyalty_voucher(body, options) {
|
|
6992
|
+
return this.request('loyalty', '/loyalty/vouchers', 'POST', `/loyalty/vouchers`, body, options);
|
|
6993
|
+
}
|
|
6994
|
+
/**
|
|
6995
|
+
* GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
|
|
6996
|
+
*
|
|
6997
|
+
* @param id
|
|
6998
|
+
* @param options - additional request options
|
|
6999
|
+
*/
|
|
7000
|
+
get_loyalty_voucher(id, options) {
|
|
7001
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}', 'GET', `/loyalty/vouchers/${id}`, null, options);
|
|
7002
|
+
}
|
|
7003
|
+
/**
|
|
7004
|
+
* PUT /loyalty/vouchers/{id} - Update a voucher
|
|
7005
|
+
*
|
|
7006
|
+
* @param id
|
|
7007
|
+
* @param body
|
|
7008
|
+
* @param options - additional request options
|
|
7009
|
+
*/
|
|
7010
|
+
put_loyalty_voucher(id, body, options) {
|
|
7011
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}', 'PUT', `/loyalty/vouchers/${id}`, body, options);
|
|
7012
|
+
}
|
|
7013
|
+
/**
|
|
7014
|
+
* DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
|
|
7015
|
+
*
|
|
7016
|
+
* @param id
|
|
7017
|
+
* @param options - additional request options
|
|
7018
|
+
*/
|
|
7019
|
+
delete_loyalty_voucher(id, options) {
|
|
7020
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}', 'DELETE', `/loyalty/vouchers/${id}`, null, options);
|
|
7021
|
+
}
|
|
7022
|
+
/**
|
|
7023
|
+
* POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
|
|
7024
|
+
*
|
|
7025
|
+
* @param id
|
|
7026
|
+
* @param body
|
|
7027
|
+
* @param options - additional request options
|
|
7028
|
+
*/
|
|
7029
|
+
post_loyalty_voucher_revoke(id, body, options) {
|
|
7030
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}/revoke', 'POST', `/loyalty/vouchers/${id}/revoke`, body, options);
|
|
7031
|
+
}
|
|
7032
|
+
/**
|
|
7033
|
+
* POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
|
|
7034
|
+
*
|
|
7035
|
+
* @param body
|
|
7036
|
+
* @param options - additional request options
|
|
7037
|
+
*/
|
|
7038
|
+
post_loyalty_vouchers_batch(body, options) {
|
|
7039
|
+
return this.request('loyalty', '/loyalty/vouchers/batch', 'POST', `/loyalty/vouchers/batch`, body, options);
|
|
7040
|
+
}
|
|
7041
|
+
/**
|
|
7042
|
+
* GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
|
|
7043
|
+
*
|
|
7044
|
+
* @param id
|
|
7045
|
+
* @param options - additional request options
|
|
7046
|
+
*/
|
|
7047
|
+
get_loyalty_voucher_redemptions(id, options) {
|
|
7048
|
+
return this.request('loyalty', '/loyalty/vouchers/{id}/redemptions', 'GET', `/loyalty/vouchers/${id}/redemptions`, null, options);
|
|
7049
|
+
}
|
|
7050
|
+
/**
|
|
7051
|
+
* POST /loyalty/vouchers/validate - Validate one or more voucher codes
|
|
7052
|
+
*
|
|
7053
|
+
* @param body
|
|
7054
|
+
* @param options - additional request options
|
|
7055
|
+
*/
|
|
7056
|
+
post_loyalty_vouchers_validate(body, options) {
|
|
7057
|
+
return this.request('loyalty', '/loyalty/vouchers/validate', 'POST', `/loyalty/vouchers/validate`, body, options);
|
|
7058
|
+
}
|
|
7059
|
+
/**
|
|
7060
|
+
* POST /loyalty/vouchers/redeem - Redeem one or more voucher codes
|
|
7061
|
+
*
|
|
7062
|
+
* @param body
|
|
7063
|
+
* @param options - additional request options
|
|
7064
|
+
*/
|
|
7065
|
+
post_loyalty_vouchers_redeem(body, options) {
|
|
7066
|
+
return this.request('loyalty', '/loyalty/vouchers/redeem', 'POST', `/loyalty/vouchers/redeem`, body, options);
|
|
7067
|
+
}
|
|
7068
|
+
/**
|
|
7069
|
+
* GET /loyalty/segments - List segments with optional filters
|
|
7070
|
+
*
|
|
7071
|
+
* @param options - additional request options
|
|
7072
|
+
*/
|
|
7073
|
+
get_loyalty_segments(options) {
|
|
7074
|
+
return this.request('loyalty', '/loyalty/segments', 'GET', `/loyalty/segments`, null, options);
|
|
7075
|
+
}
|
|
7076
|
+
/**
|
|
7077
|
+
* POST /loyalty/segments - Create a new segment
|
|
7078
|
+
*
|
|
7079
|
+
* @param body
|
|
7080
|
+
* @param options - additional request options
|
|
7081
|
+
*/
|
|
7082
|
+
post_loyalty_segment(body, options) {
|
|
7083
|
+
return this.request('loyalty', '/loyalty/segments', 'POST', `/loyalty/segments`, body, options);
|
|
7084
|
+
}
|
|
7085
|
+
/**
|
|
7086
|
+
* GET /loyalty/segments/attributes - List available attributes for rule-based segments
|
|
7087
|
+
*
|
|
7088
|
+
* @param options - additional request options
|
|
7089
|
+
*/
|
|
7090
|
+
get_loyalty_segment_attributes(options) {
|
|
7091
|
+
return this.request('loyalty', '/loyalty/segments/attributes', 'GET', `/loyalty/segments/attributes`, null, options);
|
|
7092
|
+
}
|
|
7093
|
+
/**
|
|
7094
|
+
* POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
|
|
7095
|
+
*
|
|
7096
|
+
* @param body
|
|
7097
|
+
* @param options - additional request options
|
|
7098
|
+
*/
|
|
7099
|
+
post_loyalty_segment_preview_count(body, options) {
|
|
7100
|
+
return this.request('loyalty', '/loyalty/segments/preview-count', 'POST', `/loyalty/segments/preview-count`, body, options);
|
|
7101
|
+
}
|
|
7102
|
+
/**
|
|
7103
|
+
* GET /loyalty/segments/{id} - Get segment by ID
|
|
7104
|
+
*
|
|
7105
|
+
* @param id
|
|
7106
|
+
* @param options - additional request options
|
|
7107
|
+
*/
|
|
7108
|
+
get_loyalty_segment(id, options) {
|
|
7109
|
+
return this.request('loyalty', '/loyalty/segments/{id}', 'GET', `/loyalty/segments/${id}`, null, options);
|
|
7110
|
+
}
|
|
7111
|
+
/**
|
|
7112
|
+
* PATCH /loyalty/segments/{id} - Update a segment
|
|
7113
|
+
*
|
|
7114
|
+
* @param id
|
|
7115
|
+
* @param body
|
|
7116
|
+
* @param options - additional request options
|
|
7117
|
+
*/
|
|
7118
|
+
patch_loyalty_segment(id, body, options) {
|
|
7119
|
+
return this.request('loyalty', '/loyalty/segments/{id}', 'PATCH', `/loyalty/segments/${id}`, body, options);
|
|
7120
|
+
}
|
|
7121
|
+
/**
|
|
7122
|
+
* DELETE /loyalty/segments/{id} - Soft-delete a segment
|
|
7123
|
+
*
|
|
7124
|
+
* @param id
|
|
7125
|
+
* @param options - additional request options
|
|
7126
|
+
*/
|
|
7127
|
+
delete_loyalty_segment(id, options) {
|
|
7128
|
+
return this.request('loyalty', '/loyalty/segments/{id}', 'DELETE', `/loyalty/segments/${id}`, null, options);
|
|
7129
|
+
}
|
|
7130
|
+
/**
|
|
7131
|
+
* GET /loyalty/segments/{id}/members - List members of a static_list segment
|
|
7132
|
+
*
|
|
7133
|
+
* @param id
|
|
7134
|
+
* @param options - additional request options
|
|
7135
|
+
*/
|
|
7136
|
+
get_loyalty_segment_members(id, options) {
|
|
7137
|
+
return this.request('loyalty', '/loyalty/segments/{id}/members', 'GET', `/loyalty/segments/${id}/members`, null, options);
|
|
7138
|
+
}
|
|
7139
|
+
/**
|
|
7140
|
+
* POST /loyalty/segments/{id}/members - Add members to a segment
|
|
7141
|
+
*
|
|
7142
|
+
* @param id
|
|
7143
|
+
* @param body
|
|
7144
|
+
* @param options - additional request options
|
|
7145
|
+
*/
|
|
7146
|
+
post_loyalty_segment_members(id, body, options) {
|
|
7147
|
+
return this.request('loyalty', '/loyalty/segments/{id}/members', 'POST', `/loyalty/segments/${id}/members`, body, options);
|
|
7148
|
+
}
|
|
7149
|
+
/**
|
|
7150
|
+
* DELETE /loyalty/segments/{id}/members - Remove members from a segment
|
|
7151
|
+
*
|
|
7152
|
+
* @param id
|
|
7153
|
+
* @param body
|
|
7154
|
+
* @param options - additional request options
|
|
7155
|
+
*/
|
|
7156
|
+
delete_loyalty_segment_members(id, body, options) {
|
|
7157
|
+
return this.request('loyalty', '/loyalty/segments/{id}/members', 'DELETE', `/loyalty/segments/${id}/members`, body, options);
|
|
7158
|
+
}
|
|
7159
|
+
/**
|
|
7160
|
+
* POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
|
|
7161
|
+
*
|
|
7162
|
+
* @param id
|
|
7163
|
+
* @param body
|
|
7164
|
+
* @param options - additional request options
|
|
7165
|
+
*/
|
|
7166
|
+
post_loyalty_redemption_rollback(id, body, options) {
|
|
7167
|
+
return this.request('loyalty', '/loyalty/redemptions/{id}/rollback', 'POST', `/loyalty/redemptions/${id}/rollback`, body, options);
|
|
7168
|
+
}
|
|
7169
|
+
/**
|
|
7170
|
+
* GET /loyalty/rewards - List rewards with filters and pagination
|
|
7171
|
+
*
|
|
7172
|
+
* @param options - additional request options
|
|
7173
|
+
*/
|
|
7174
|
+
get_loyalty_rewards(options) {
|
|
7175
|
+
return this.request('loyalty', '/loyalty/rewards', 'GET', `/loyalty/rewards`, null, options);
|
|
7176
|
+
}
|
|
7177
|
+
/**
|
|
7178
|
+
* POST /loyalty/rewards - Create a reward with earning rules and milestones
|
|
7179
|
+
*
|
|
7180
|
+
* @param body
|
|
7181
|
+
* @param options - additional request options
|
|
7182
|
+
*/
|
|
7183
|
+
post_loyalty_reward(body, options) {
|
|
7184
|
+
return this.request('loyalty', '/loyalty/rewards', 'POST', `/loyalty/rewards`, body, options);
|
|
7185
|
+
}
|
|
7186
|
+
/**
|
|
7187
|
+
* GET /loyalty/rewards/{id} - Get reward detail with earning rules and milestones
|
|
7188
|
+
*
|
|
7189
|
+
* @param id
|
|
7190
|
+
* @param options - additional request options
|
|
7191
|
+
*/
|
|
7192
|
+
get_loyalty_reward(id, options) {
|
|
7193
|
+
return this.request('loyalty', '/loyalty/rewards/{id}', 'GET', `/loyalty/rewards/${id}`, null, options);
|
|
7194
|
+
}
|
|
7195
|
+
/**
|
|
7196
|
+
* PUT /loyalty/rewards/{id} - Update a reward and replace its earning rules and milestones
|
|
7197
|
+
*
|
|
7198
|
+
* @param id
|
|
7199
|
+
* @param body
|
|
7200
|
+
* @param options - additional request options
|
|
7201
|
+
*/
|
|
7202
|
+
put_loyalty_reward(id, body, options) {
|
|
7203
|
+
return this.request('loyalty', '/loyalty/rewards/{id}', 'PUT', `/loyalty/rewards/${id}`, body, options);
|
|
7204
|
+
}
|
|
7205
|
+
/**
|
|
7206
|
+
* PATCH /loyalty/rewards/{id}/status - Transition reward status
|
|
7207
|
+
*
|
|
7208
|
+
* @param id
|
|
7209
|
+
* @param body
|
|
7210
|
+
* @param options - additional request options
|
|
7211
|
+
*/
|
|
7212
|
+
patch_loyalty_reward_status(id, body, options) {
|
|
7213
|
+
return this.request('loyalty', '/loyalty/rewards/{id}/status', 'PATCH', `/loyalty/rewards/${id}/status`, body, options);
|
|
7214
|
+
}
|
|
7215
|
+
/**
|
|
7216
|
+
* GET /loyalty/rewards/{id}/cards - List enrolled customer cards for a reward
|
|
7217
|
+
*
|
|
7218
|
+
* @param id
|
|
7219
|
+
* @param options - additional request options
|
|
7220
|
+
*/
|
|
7221
|
+
get_loyalty_reward_cards(id, options) {
|
|
7222
|
+
return this.request('loyalty', '/loyalty/rewards/{id}/cards', 'GET', `/loyalty/rewards/${id}/cards`, null, options);
|
|
7223
|
+
}
|
|
7224
|
+
/**
|
|
7225
|
+
* GET /loyalty/rewards/{id}/cards/{customerId} - Get card detail with transaction event history
|
|
7226
|
+
*
|
|
7227
|
+
* @param id
|
|
7228
|
+
* @param customerId
|
|
7229
|
+
* @param options - additional request options
|
|
7230
|
+
*/
|
|
7231
|
+
get_loyalty_reward_card(id, customerId, options) {
|
|
7232
|
+
return this.request('loyalty', '/loyalty/rewards/{id}/cards/{customerId}', 'GET', `/loyalty/rewards/${id}/cards/${customerId}`, null, options);
|
|
7233
|
+
}
|
|
7234
|
+
/**
|
|
7235
|
+
* POST /loyalty/rewards/cards/{cardId}/adjust - Manual point adjustment on a reward card
|
|
7236
|
+
*
|
|
7237
|
+
* @param cardId
|
|
7238
|
+
* @param body
|
|
7239
|
+
* @param options - additional request options
|
|
7240
|
+
*/
|
|
7241
|
+
post_loyalty_reward_card_adjust(cardId, body, options) {
|
|
7242
|
+
return this.request('loyalty', '/loyalty/rewards/cards/{cardId}/adjust', 'POST', `/loyalty/rewards/cards/${cardId}/adjust`, body, options);
|
|
7243
|
+
}
|
|
7244
|
+
/**
|
|
7245
|
+
* POST /loyalty/rewards/orders/earn - Evaluate an order against active reward rules and award points idempotently
|
|
7246
|
+
*
|
|
7247
|
+
* @param body
|
|
7248
|
+
* @param options - additional request options
|
|
7249
|
+
*/
|
|
7250
|
+
post_loyalty_reward_order_earn(body, options) {
|
|
7251
|
+
return this.request('loyalty', '/loyalty/rewards/orders/earn', 'POST', `/loyalty/rewards/orders/earn`, body, options);
|
|
7252
|
+
}
|
|
6868
7253
|
/**
|
|
6869
7254
|
* GET /timeslots/brand/{brandId} - Get timeslots for brand
|
|
6870
7255
|
*
|