voucherify 8.0.1 → 8.0.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.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +64 -60
- data/Gemfile.lock +4 -4
- data/README.md +11 -0
- data/docs/Campaign.md +2 -2
- data/docs/CampaignBase.md +2 -2
- data/docs/CampaignsApi.md +3 -3
- data/docs/CampaignsCreateRequestBody.md +1 -1
- data/docs/CampaignsCreateResponseBody.md +2 -2
- data/docs/CampaignsGetResponseBody.md +2 -2
- data/docs/CampaignsUpdateRequestBody.md +2 -2
- data/docs/CampaignsUpdateResponseBody.md +2 -2
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md +3 -2
- data/docs/Error.md +1 -0
- data/docs/ErrorError.md +8 -0
- data/docs/LoyaltiesCreateCampaignRequestBody.md +1 -1
- data/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +1 -1
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +9 -9
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md +1 -1
- data/docs/LoyaltiesUpdateCampaignRequestBody.md +2 -2
- data/docs/LoyaltyCardTransaction.md +2 -2
- data/docs/LoyaltyCardTransactionDetailsBalance.md +5 -4
- data/docs/LoyaltyCardTransactionDetailsBalanceRelatedObject.md +1 -1
- data/docs/LoyaltyPointsBucket.md +16 -0
- data/docs/LoyaltyPointsBucketBucket.md +8 -0
- data/docs/Order.md +1 -1
- data/docs/OrderCalculated.md +1 -1
- data/docs/OrderCalculatedItem.md +1 -1
- data/docs/OrderCalculatedItemProduct.md +1 -1
- data/docs/OrderCalculatedItemSku.md +1 -0
- data/docs/OrderItem.md +1 -1
- data/docs/OrderItemProduct.md +1 -1
- data/docs/OrderItemSku.md +1 -0
- data/docs/OrdersCreateRequestBody.md +1 -1
- data/docs/OrdersCreateResponseBody.md +1 -1
- data/docs/OrdersGetResponseBody.md +1 -1
- data/docs/OrdersImportCreateRequestBodyItem.md +1 -1
- data/docs/OrdersUpdateRequestBody.md +1 -1
- data/docs/OrdersUpdateResponseBody.md +1 -1
- data/docs/Product.md +1 -1
- data/docs/ProductCollectionsProductsListResponseBodyDataItem.md +1 -1
- data/docs/ProductWithoutSkus.md +1 -1
- data/docs/ProductsCreateResponseBody.md +1 -1
- data/docs/ProductsGetResponseBody.md +1 -1
- data/docs/ProductsSkusCreateResponseBody.md +1 -1
- data/docs/ProductsSkusUpdateResponseBody.md +1 -1
- data/docs/ProductsUpdateResponseBody.md +1 -1
- data/docs/RedemptionEntryOrder.md +1 -1
- data/docs/RedemptionsGetResponseBodyOrder.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +1 -1
- data/docs/Sku.md +1 -1
- data/docs/SkusGetResponseBody.md +1 -1
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +1 -1
- data/docs/ValidationsRedeemableInapplicable.md +3 -2
- data/docs/ValidationsRedeemableSkipped.md +3 -2
- data/docs/ValidationsValidateResponseBodyRedeemablesItem.md +3 -2
- data/docs/VoucherBalance.md +14 -0
- data/docs/VoucherBalanceRelatedObject.md +9 -0
- data/docs/VoucherTransaction.md +2 -2
- data/docs/VoucherTransactionDetailsBalance.md +5 -4
- data/docs/VoucherTransactionDetailsBalanceRelatedObject.md +1 -1
- data/docs/VouchersApi.md +6 -6
- data/docs/VouchersBalanceUpdateResponseBody.md +1 -1
- data/lib/VoucherifySdk/api/campaigns_api.rb +4 -4
- data/lib/VoucherifySdk/api/vouchers_api.rb +10 -10
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/campaign.rb +3 -3
- data/lib/VoucherifySdk/models/campaign_base.rb +3 -3
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +3 -3
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +3 -3
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +3 -3
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item.rb +18 -7
- data/lib/VoucherifySdk/models/error.rb +15 -5
- data/lib/VoucherifySdk/models/error_error.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +27 -77
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb +3 -9
- data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +24 -31
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +0 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +18 -19
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance_related_object.rb +1 -7
- data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +323 -0
- data/lib/VoucherifySdk/models/loyalty_points_bucket_bucket.rb +210 -0
- data/lib/VoucherifySdk/models/order.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated_item_product.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated_item_sku.rb +16 -5
- data/lib/VoucherifySdk/models/order_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_item_product.rb +1 -1
- data/lib/VoucherifySdk/models/order_item_sku.rb +16 -5
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +1 -1
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_expand_list_campaigns.rb +2 -1
- data/lib/VoucherifySdk/models/product.rb +1 -1
- data/lib/VoucherifySdk/models/product_collections_products_list_response_body_data_item.rb +1 -1
- data/lib/VoucherifySdk/models/product_without_skus.rb +1 -1
- data/lib/VoucherifySdk/models/products_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_order.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +1 -1
- data/lib/VoucherifySdk/models/sku.rb +1 -1
- data/lib/VoucherifySdk/models/skus_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +18 -7
- data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +18 -7
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item.rb +18 -7
- data/lib/VoucherifySdk/models/voucher_balance.rb +305 -0
- data/lib/VoucherifySdk/models/voucher_balance_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/voucher_transaction.rb +27 -31
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +0 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +18 -19
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance_related_object.rb +1 -7
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +1 -0
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c15c05945ed82f7bef1191b3186335aca48d3641d99bd9c002f6faa66866a63f
|
|
4
|
+
data.tar.gz: fbd696a83b34e8d9008f16182374db4295af439c14826d8dbaf7f47d532bba86
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6a24f0e608743dde0c27985b8b3c2ddc61b6db9a1341a03784d74bc38a73d17bad6588312abb27c0b61e87d31572842158926e7c93934ad3b4f6bc4650e37b42
|
|
7
|
+
data.tar.gz: ece2ba582e4243dacd844c4c9ef8418895592c62beed97901c3e9018836de72088d8d9f5ff77a2f24dbc3e0e524353d61a54d7b9798e95acd3668a95609f835d
|
data/Dockerfile
CHANGED
data/ENDPOINTS-COVERAGE.md
CHANGED
|
@@ -79,20 +79,22 @@
|
|
|
79
79
|
| /v1/vouchers/{code}/sessions/{sessionKey} | delete | Release Validation Session | <font color='green'>supported</font> | |
|
|
80
80
|
| /v1/vouchers/qualification | post | Examine Qualification [Deprecated] | | <font color='red'>deprecated</font> |
|
|
81
81
|
## Campaigns
|
|
82
|
-
| endpoint
|
|
83
|
-
|
|
|
84
|
-
| /v1/campaigns
|
|
85
|
-
| /v1/campaigns
|
|
86
|
-
| /v1/campaigns/{campaignId}
|
|
87
|
-
| /v1/campaigns/{campaignId}
|
|
88
|
-
| /v1/campaigns/{campaignId}
|
|
89
|
-
| /v1/campaigns/{campaignId}/vouchers
|
|
90
|
-
| /v1/campaigns/{campaignId}/vouchers/{code}
|
|
91
|
-
| /v1/campaigns/{campaignId}/import
|
|
92
|
-
| /v1/campaigns/{campaignId}/importCSV
|
|
93
|
-
| /v1/campaigns/qualification
|
|
94
|
-
| /v1/campaigns/{campaignId}/enable
|
|
95
|
-
| /v1/campaigns/{campaignId}/disable
|
|
82
|
+
| endpoint | method | summary | is supported | is deprecated |
|
|
83
|
+
| ---------------------------------------------- | ------ | ------------------------------------------ | ------------------------------------ | ------------------------------------ |
|
|
84
|
+
| /v1/campaigns | post | Create Campaign | <font color='green'>supported</font> | |
|
|
85
|
+
| /v1/campaigns | get | List Campaigns | <font color='green'>supported</font> | |
|
|
86
|
+
| /v1/campaigns/{campaignId} | get | Get Campaign | <font color='green'>supported</font> | |
|
|
87
|
+
| /v1/campaigns/{campaignId} | put | Update Campaign | <font color='green'>supported</font> | |
|
|
88
|
+
| /v1/campaigns/{campaignId} | delete | Delete Campaign | <font color='green'>supported</font> | |
|
|
89
|
+
| /v1/campaigns/{campaignId}/vouchers | post | Add Vouchers to Campaign | <font color='green'>supported</font> | |
|
|
90
|
+
| /v1/campaigns/{campaignId}/vouchers/{code} | post | Add Voucher with Specific Code to Campaign | <font color='green'>supported</font> | |
|
|
91
|
+
| /v1/campaigns/{campaignId}/import | post | Import Vouchers to Campaign | <font color='green'>supported</font> | |
|
|
92
|
+
| /v1/campaigns/{campaignId}/importCSV | post | Import Vouchers to Campaign by CSV | <font color='green'>supported</font> | |
|
|
93
|
+
| /v1/campaigns/qualification | post | Examine Qualification [Deprecated] | | <font color='red'>deprecated</font> |
|
|
94
|
+
| /v1/campaigns/{campaignId}/enable | post | Enable Campaign | <font color='green'>supported</font> | |
|
|
95
|
+
| /v1/campaigns/{campaignId}/disable | post | Disable Campaign | <font color='green'>supported</font> | |
|
|
96
|
+
| /v1/campaigns/{campaignId}/transactions | get | List Campaign Transactions | | |
|
|
97
|
+
| /v1/campaigns/{campaignId}/transactions/export | post | Export Campaign Transactions | | |
|
|
96
98
|
## Promotions
|
|
97
99
|
| endpoint | method | summary | is supported | is deprecated |
|
|
98
100
|
| ---------------------------------------------- | ------ | ---------------------------------- | ------------------------------------ | ------------- |
|
|
@@ -124,52 +126,54 @@
|
|
|
124
126
|
| /v1/rewards/{rewardId}/assignments/{assignmentId} | delete | Delete Reward Assignment | <font color='green'>supported</font> | |
|
|
125
127
|
| /v1/rewards/{rewardId}/assignments/{assignmentId} | get | Get Reward Assignment | <font color='green'>supported</font> | |
|
|
126
128
|
## Loyalties
|
|
127
|
-
| endpoint | method | summary
|
|
128
|
-
| ------------------------------------------------------------------- | ------ |
|
|
129
|
-
| /v1/loyalties | get | List Loyalty Campaigns
|
|
130
|
-
| /v1/loyalties | post | Create Loyalty Campaign
|
|
131
|
-
| /v1/loyalties/{campaignId} | get | Get Loyalty Campaign
|
|
132
|
-
| /v1/loyalties/{campaignId} | put | Update Loyalty Campaign
|
|
133
|
-
| /v1/loyalties/{campaignId} | delete | Delete Loyalty Campaign
|
|
134
|
-
| /v1/loyalties/{campaignId}/members | get | List Members
|
|
135
|
-
| /v1/loyalties/{campaignId}/members | post | Add Member
|
|
136
|
-
| /v1/loyalties/{campaignId}/members/{memberId} | get | Get Member
|
|
137
|
-
| /v1/loyalties/members/{memberId} | get | Get Member
|
|
138
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/activity | get | List Member Activity
|
|
139
|
-
| /v1/loyalties/members/{memberId}/activity | get | List Member Activity
|
|
140
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance
|
|
141
|
-
| /v1/loyalties/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance
|
|
142
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/transfers | post | Transfer Loyalty Points
|
|
143
|
-
| /v1/loyalties/{campaignId}/
|
|
144
|
-
| /v1/loyalties/
|
|
145
|
-
| /v1/loyalties/members/{memberId}/transactions
|
|
146
|
-
| /v1/loyalties/
|
|
147
|
-
| /v1/loyalties/
|
|
148
|
-
| /v1/loyalties/{campaignId}/
|
|
149
|
-
| /v1/loyalties/{campaignId}/
|
|
150
|
-
| /v1/loyalties/{campaignId}/
|
|
151
|
-
| /v1/loyalties/{campaignId}/earning-rules
|
|
152
|
-
| /v1/loyalties/{campaignId}/earning-rules
|
|
153
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} |
|
|
154
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}
|
|
155
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}
|
|
156
|
-
| /v1/loyalties/
|
|
157
|
-
| /v1/loyalties/{campaignId}/
|
|
158
|
-
| /v1/loyalties/{
|
|
159
|
-
| /v1/loyalties/{campaignId}/
|
|
160
|
-
| /v1/loyalties/{campaignId}/
|
|
161
|
-
| /v1/loyalties/{campaignId}/
|
|
162
|
-
| /v1/loyalties/{campaignId}/rewards
|
|
163
|
-
| /v1/loyalties/{campaignId}/
|
|
164
|
-
| /v1/loyalties/{campaignId}/rewards/{assignmentId} |
|
|
165
|
-
| /v1/loyalties/{campaignId}/
|
|
166
|
-
| /v1/loyalties/
|
|
167
|
-
| /v1/loyalties/{campaignId}/
|
|
168
|
-
| /v1/loyalties/{
|
|
169
|
-
| /v1/loyalties/{campaignId}/tiers
|
|
170
|
-
| /v1/loyalties/
|
|
171
|
-
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}
|
|
172
|
-
| /v1/loyalties/{
|
|
129
|
+
| endpoint | method | summary | is supported | is deprecated |
|
|
130
|
+
| ------------------------------------------------------------------- | ------ | ------------------------------------ | ------------------------------------ | ------------- |
|
|
131
|
+
| /v1/loyalties | get | List Loyalty Campaigns | <font color='green'>supported</font> | |
|
|
132
|
+
| /v1/loyalties | post | Create Loyalty Campaign | <font color='green'>supported</font> | |
|
|
133
|
+
| /v1/loyalties/{campaignId} | get | Get Loyalty Campaign | <font color='green'>supported</font> | |
|
|
134
|
+
| /v1/loyalties/{campaignId} | put | Update Loyalty Campaign | <font color='green'>supported</font> | |
|
|
135
|
+
| /v1/loyalties/{campaignId} | delete | Delete Loyalty Campaign | <font color='green'>supported</font> | |
|
|
136
|
+
| /v1/loyalties/{campaignId}/members | get | List Members | <font color='green'>supported</font> | |
|
|
137
|
+
| /v1/loyalties/{campaignId}/members | post | Add Member | <font color='green'>supported</font> | |
|
|
138
|
+
| /v1/loyalties/{campaignId}/members/{memberId} | get | Get Member | <font color='green'>supported</font> | |
|
|
139
|
+
| /v1/loyalties/members/{memberId} | get | Get Member | <font color='green'>supported</font> | |
|
|
140
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/activity | get | List Member Activity | <font color='green'>supported</font> | |
|
|
141
|
+
| /v1/loyalties/members/{memberId}/activity | get | List Member Activity | <font color='green'>supported</font> | |
|
|
142
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance | <font color='green'>supported</font> | |
|
|
143
|
+
| /v1/loyalties/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance | <font color='green'>supported</font> | |
|
|
144
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/transfers | post | Transfer Loyalty Points | <font color='green'>supported</font> | |
|
|
145
|
+
| /v1/loyalties/{campaignId}/transactions | get | List Loyalty Campaign Transactions | | |
|
|
146
|
+
| /v1/loyalties/{campaignId}/transactions/export | post | Export Loyalty Campaign Transactions | | |
|
|
147
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/transactions | get | List Loyalty Card Transactions | <font color='green'>supported</font> | |
|
|
148
|
+
| /v1/loyalties/members/{memberId}/transactions | get | List Loyalty Card Transactions | <font color='green'>supported</font> | |
|
|
149
|
+
| /v1/loyalties/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | <font color='green'>supported</font> | |
|
|
150
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | <font color='green'>supported</font> | |
|
|
151
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | get | Get Points Expiration | <font color='green'>supported</font> | |
|
|
152
|
+
| /v1/loyalties/{campaignId}/points-expiration/export | post | Create Points Expiration Export | <font color='green'>supported</font> | |
|
|
153
|
+
| /v1/loyalties/{campaignId}/earning-rules | get | List Earning Rules | <font color='green'>supported</font> | |
|
|
154
|
+
| /v1/loyalties/{campaignId}/earning-rules | post | Create Earning Rule | <font color='green'>supported</font> | |
|
|
155
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | get | Get Earning Rule | <font color='green'>supported</font> | |
|
|
156
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | put | Update Earning Rule | <font color='green'>supported</font> | |
|
|
157
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | delete | Delete Earning Rule | <font color='green'>supported</font> | |
|
|
158
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | post | Enable Earning Rule | <font color='green'>supported</font> | |
|
|
159
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | post | Disable Earning Rule | <font color='green'>supported</font> | |
|
|
160
|
+
| /v1/loyalties/members/{memberId}/rewards | get | List Member Rewards | <font color='green'>supported</font> | |
|
|
161
|
+
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | get | Get Reward Details | <font color='green'>supported</font> | |
|
|
162
|
+
| /v1/loyalties/{campaignId}/reward-assignments | get | List Reward Assignments | <font color='green'>supported</font> | |
|
|
163
|
+
| /v1/loyalties/{campaignId}/rewards | get | List Reward Assignments | <font color='green'>supported</font> | |
|
|
164
|
+
| /v1/loyalties/{campaignId}/rewards | post | Create Reward Assignment | <font color='green'>supported</font> | |
|
|
165
|
+
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | get | Get Reward Assignment | <font color='green'>supported</font> | |
|
|
166
|
+
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | get | Get Reward Assignment | <font color='green'>supported</font> | |
|
|
167
|
+
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | put | Update Reward Assignment | <font color='green'>supported</font> | |
|
|
168
|
+
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | delete | Delete Reward Assignment | <font color='green'>supported</font> | |
|
|
169
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/redemption | post | Redeem Reward | <font color='green'>supported</font> | |
|
|
170
|
+
| /v1/loyalties/members/{memberId}/redemption | post | Redeem Reward | <font color='green'>supported</font> | |
|
|
171
|
+
| /v1/loyalties/{campaignId}/tiers | get | List Loyalty Tiers | <font color='green'>supported</font> | |
|
|
172
|
+
| /v1/loyalties/{campaignId}/tiers | post | Create loyalty tiers | <font color='green'>supported</font> | |
|
|
173
|
+
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | get | Get Loyalty Tier | <font color='green'>supported</font> | |
|
|
174
|
+
| /v1/loyalties/members/{memberId}/tiers | get | List Member's Loyalty Tiers | <font color='green'>supported</font> | |
|
|
175
|
+
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | get | List Loyalty Tier Earning Rules | <font color='green'>supported</font> | |
|
|
176
|
+
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | get | List Loyalty Tier Rewards | <font color='green'>supported</font> | |
|
|
173
177
|
## Customers
|
|
174
178
|
| endpoint | method | summary | is supported | is deprecated |
|
|
175
179
|
| --------------------------------------------- | ------ | ------------------------------------- | ------------------------------------ | ------------------------------------ |
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
voucherify (8.0.
|
|
4
|
+
voucherify (8.0.2)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -17,7 +17,7 @@ GEM
|
|
|
17
17
|
jaro_winkler (1.5.6)
|
|
18
18
|
method_source (1.1.0)
|
|
19
19
|
parallel (1.26.3)
|
|
20
|
-
parser (3.3.
|
|
20
|
+
parser (3.3.6.0)
|
|
21
21
|
ast (~> 2.4.1)
|
|
22
22
|
racc
|
|
23
23
|
pry (0.14.2)
|
|
@@ -26,7 +26,7 @@ GEM
|
|
|
26
26
|
pry-byebug (3.10.1)
|
|
27
27
|
byebug (~> 11.0)
|
|
28
28
|
pry (>= 0.13, < 0.15)
|
|
29
|
-
psych (5.
|
|
29
|
+
psych (5.2.0)
|
|
30
30
|
stringio
|
|
31
31
|
racc (1.8.1)
|
|
32
32
|
rainbow (3.1.1)
|
|
@@ -53,7 +53,7 @@ GEM
|
|
|
53
53
|
ruby-progressbar (~> 1.7)
|
|
54
54
|
unicode-display_width (>= 1.4.0, < 1.6)
|
|
55
55
|
ruby-progressbar (1.13.0)
|
|
56
|
-
stringio (3.1.
|
|
56
|
+
stringio (3.1.2)
|
|
57
57
|
typhoeus (1.4.1)
|
|
58
58
|
ethon (>= 0.9.0)
|
|
59
59
|
unicode-display_width (1.5.0)
|
data/README.md
CHANGED
|
@@ -113,6 +113,12 @@ Remember that this SDK is auto generated (except of the tests) so changes made h
|
|
|
113
113
|
|
|
114
114
|
## 📅 Changelog
|
|
115
115
|
|
|
116
|
+
- **2024-11-26** - `8.0.2`
|
|
117
|
+
- Added support for `STANDALONE` campaign type.
|
|
118
|
+
- Added optional `metadata` in `OrderCalculatedItemSku`
|
|
119
|
+
- New possible value of `ParameterExpandListCampaigns`
|
|
120
|
+
- New optional `error` parameter in `Error`
|
|
121
|
+
- Updated `LoyaltyCardTransactionDetailsBalance`
|
|
116
122
|
- **2024-11-04** - `8.0.1`
|
|
117
123
|
- Added support for returning `campaign_id` and `campaign_name` in stackable validation endpoint, when `redeemable` option is expanded
|
|
118
124
|
- **2024-10-28** - `8.0.0`
|
|
@@ -618,6 +624,7 @@ Class | Method | HTTP request | Description
|
|
|
618
624
|
- [VoucherifySdk::EarningRuleSegment](docs/EarningRuleSegment.md)
|
|
619
625
|
- [VoucherifySdk::EarningRuleSource](docs/EarningRuleSource.md)
|
|
620
626
|
- [VoucherifySdk::Error](docs/Error.md)
|
|
627
|
+
- [VoucherifySdk::ErrorError](docs/ErrorError.md)
|
|
621
628
|
- [VoucherifySdk::EventsCreateRequestBody](docs/EventsCreateRequestBody.md)
|
|
622
629
|
- [VoucherifySdk::EventsCreateRequestBodyLoyalty](docs/EventsCreateRequestBodyLoyalty.md)
|
|
623
630
|
- [VoucherifySdk::EventsCreateRequestBodyReferral](docs/EventsCreateRequestBodyReferral.md)
|
|
@@ -903,6 +910,8 @@ Class | Method | HTTP request | Description
|
|
|
903
910
|
- [VoucherifySdk::LoyaltyMemberLoyaltyCard](docs/LoyaltyMemberLoyaltyCard.md)
|
|
904
911
|
- [VoucherifySdk::LoyaltyMemberPublish](docs/LoyaltyMemberPublish.md)
|
|
905
912
|
- [VoucherifySdk::LoyaltyMemberRedemption](docs/LoyaltyMemberRedemption.md)
|
|
913
|
+
- [VoucherifySdk::LoyaltyPointsBucket](docs/LoyaltyPointsBucket.md)
|
|
914
|
+
- [VoucherifySdk::LoyaltyPointsBucketBucket](docs/LoyaltyPointsBucketBucket.md)
|
|
906
915
|
- [VoucherifySdk::LoyaltyTier](docs/LoyaltyTier.md)
|
|
907
916
|
- [VoucherifySdk::LoyaltyTierBase](docs/LoyaltyTierBase.md)
|
|
908
917
|
- [VoucherifySdk::LoyaltyTierBasePoints](docs/LoyaltyTierBasePoints.md)
|
|
@@ -1520,6 +1529,8 @@ Class | Method | HTTP request | Description
|
|
|
1520
1529
|
- [VoucherifySdk::VoucherAssets](docs/VoucherAssets.md)
|
|
1521
1530
|
- [VoucherifySdk::VoucherAssetsBarcode](docs/VoucherAssetsBarcode.md)
|
|
1522
1531
|
- [VoucherifySdk::VoucherAssetsQr](docs/VoucherAssetsQr.md)
|
|
1532
|
+
- [VoucherifySdk::VoucherBalance](docs/VoucherBalance.md)
|
|
1533
|
+
- [VoucherifySdk::VoucherBalanceRelatedObject](docs/VoucherBalanceRelatedObject.md)
|
|
1523
1534
|
- [VoucherifySdk::VoucherGift](docs/VoucherGift.md)
|
|
1524
1535
|
- [VoucherifySdk::VoucherLoyaltyCard](docs/VoucherLoyaltyCard.md)
|
|
1525
1536
|
- [VoucherifySdk::VoucherPublish](docs/VoucherPublish.md)
|
data/docs/Campaign.md
CHANGED
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
| **name** | **String** | Campaign name. | [optional] |
|
|
9
9
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
10
|
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
12
12
|
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
13
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
15
15
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
16
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
data/docs/CampaignBase.md
CHANGED
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
| **name** | **String** | Campaign name. | [optional] |
|
|
9
9
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
10
|
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
12
12
|
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
13
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
15
15
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
16
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
data/docs/CampaignsApi.md
CHANGED
|
@@ -151,7 +151,7 @@ end
|
|
|
151
151
|
|
|
152
152
|
Create Campaign
|
|
153
153
|
|
|
154
|
-
Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. 📘 Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description.
|
|
154
|
+
Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. 📘 Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
|
|
155
155
|
|
|
156
156
|
### Examples
|
|
157
157
|
|
|
@@ -596,7 +596,7 @@ opts = {
|
|
|
596
596
|
limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
597
597
|
page: 56, # Integer | Which page of results to return. The lowest value is 1.
|
|
598
598
|
campaign_type: VoucherifySdk::ParameterCampaignType::PROMOTION, # ParameterCampaignType | This attribute allows filtering by campaign type.
|
|
599
|
-
expand: VoucherifySdk::ParameterExpandListCampaigns::CATEGORY, # ParameterExpandListCampaigns |
|
|
599
|
+
expand: VoucherifySdk::ParameterExpandListCampaigns::CATEGORY, # ParameterExpandListCampaigns | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.
|
|
600
600
|
order: VoucherifySdk::ParameterOrderListCampaigns::CREATED_AT, # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
601
601
|
filters: VoucherifySdk::ParameterFiltersListCampaigns.new # ParameterFiltersListCampaigns | Filters the results by campaign status or whether the campaign is a referral campaign.
|
|
602
602
|
}
|
|
@@ -617,7 +617,7 @@ end
|
|
|
617
617
|
| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] |
|
|
618
618
|
| **page** | **Integer** | Which page of results to return. The lowest value is 1. | [optional] |
|
|
619
619
|
| **campaign_type** | [**ParameterCampaignType**](.md) | This attribute allows filtering by campaign type. | [optional] |
|
|
620
|
-
| **expand** | [**ParameterExpandListCampaigns**](.md) |
|
|
620
|
+
| **expand** | [**ParameterExpandListCampaigns**](.md) | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. | [optional] |
|
|
621
621
|
| **order** | [**ParameterOrderListCampaigns**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
622
622
|
| **filters** | [**ParameterFiltersListCampaigns**](.md) | Filters the results by campaign status or whether the campaign is a referral campaign. | [optional] |
|
|
623
623
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Campaign name. | [optional] |
|
|
8
8
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
9
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
9
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published | [optional] |
|
|
10
10
|
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
11
11
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
12
12
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
| **name** | **String** | Campaign name. | [optional] |
|
|
9
9
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
10
|
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
12
12
|
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
13
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
15
15
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
16
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
| **name** | **String** | Campaign name. | [optional] |
|
|
9
9
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
10
|
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
12
12
|
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
13
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
15
15
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
16
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
| **unset_metadata_fields** | **Array<String>** | Determine which metadata should be removed from campaign. | [optional] |
|
|
16
16
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
|
|
17
17
|
| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
|
|
18
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
18
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
19
19
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
20
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
20
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. | [optional] |
|
|
21
21
|
| **discount** | [**Discount**](Discount.md) | | [optional] |
|
|
22
22
|
| **referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|
|
23
23
|
| **gift** | [**Gift**](Gift.md) | | [optional] |
|
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
| **name** | **String** | Campaign name. | [optional] |
|
|
9
9
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
10
|
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
12
12
|
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
13
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
15
15
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
16
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **result** | [**ClientValidationsValidateResponseBodyRedeemablesItemResult**](ClientValidationsValidateResponseBodyRedeemablesItemResult.md) | | [optional] |
|
|
14
14
|
| **metadata** | **Object** | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redeemable. | [optional] |
|
|
15
15
|
| **categories** | [**Array<CategoryWithStackingRulesType>**](CategoryWithStackingRulesType.md) | | [optional] |
|
|
16
|
-
| **campaign_name** | **String** | Campaign name | [optional] |
|
|
17
|
-
| **campaign_id** | **String** | Unique campaign ID assigned by Voucherify. | [optional] |
|
|
16
|
+
| **campaign_name** | **String** | Campaign name. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] |
|
|
17
|
+
| **campaign_id** | **String** | Unique campaign ID assigned by Voucherify. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] |
|
|
18
|
+
| **name** | **String** | Name of the promotion tier. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] |
|
|
18
19
|
|
data/docs/Error.md
CHANGED
|
@@ -11,4 +11,5 @@
|
|
|
11
11
|
| **request_id** | **String** | This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team. | [optional] |
|
|
12
12
|
| **resource_id** | **String** | Unique resource ID that can be used in another endpoint to get more details. | [optional] |
|
|
13
13
|
| **resource_type** | **String** | The resource type. | [optional] |
|
|
14
|
+
| **error** | [**ErrorError**](ErrorError.md) | | [optional] |
|
|
14
15
|
|
data/docs/ErrorError.md
ADDED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Campaign name. | [optional] |
|
|
8
8
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
9
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
9
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published | [optional] |
|
|
10
10
|
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
11
11
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
12
12
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
@@ -10,5 +10,5 @@
|
|
|
10
10
|
| **type** | **String** | The type of voucher being modified. | [optional] |
|
|
11
11
|
| **object** | **String** | The type of the object represented by JSON. Default is balance. | [optional][default to 'balance'] |
|
|
12
12
|
| **related_object** | [**LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject**](LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md) | | [optional] |
|
|
13
|
-
| **operation_type** | **String** |
|
|
13
|
+
| **operation_type** | **String** | The type of operation being performed. | [optional] |
|
|
14
14
|
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | Unique loyalty points bucket
|
|
8
|
-
| **voucher_id** | **String** | Unique parent loyalty card
|
|
9
|
-
| **campaign_id** | **String** |
|
|
10
|
-
| **bucket** | [**LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket**](LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md) | |
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **updated_at** | **Time** | Timestamp representing the date and time when the loyalty
|
|
15
|
-
| **object** | **String** | The type of the object represented by JSON. This object stores information about the loyalty
|
|
7
|
+
| **id** | **String** | Unique identifier of the loyalty points bucket. | [optional] |
|
|
8
|
+
| **voucher_id** | **String** | Unique identifier of the parent loyalty card. | [optional] |
|
|
9
|
+
| **campaign_id** | **String** | Unique identifier of the parent campaign. | [optional] |
|
|
10
|
+
| **bucket** | [**LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket**](LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md) | | [optional] |
|
|
11
|
+
| **status** | **String** | Loyalty point point bucket status. | [optional] |
|
|
12
|
+
| **expires_at** | **Time** | Date when the number of points defined in the bucket object are due to expire. | [optional] |
|
|
13
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format. | [optional] |
|
|
14
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format. | [optional] |
|
|
15
|
+
| **object** | **String** | The type of the object represented by JSON. This object stores information about the loyalty point bucket. | [optional][default to 'loyalty_points_bucket'] |
|
|
16
16
|
|
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **total_points** | **Integer** | Total number of points in the loyalty
|
|
7
|
+
| **total_points** | **Integer** | Total number of points in the loyalty point bucket. | [optional] |
|
|
8
8
|
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
| **unset_metadata_fields** | **Array<String>** | Determine which metadata should be removed from campaign. | [optional] |
|
|
16
16
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
|
|
17
17
|
| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
|
|
18
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
18
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
|
|
19
19
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
20
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.
|
|
20
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. | [optional] |
|
|
21
21
|
| **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] |
|
|
22
22
|
| **options** | [**LoyaltiesUpdateCampaignRequestBodyOptions**](LoyaltiesUpdateCampaignRequestBodyOptions.md) | | [optional] |
|
|
23
23
|
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
| **campaign_id** | **String** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] |
|
|
11
11
|
| **source** | **String** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] |
|
|
12
12
|
| **reason** | **String** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] |
|
|
13
|
-
| **type** | [**LoyaltyCardTransactionsType**](LoyaltyCardTransactionsType.md) | | |
|
|
14
|
-
| **details** | [**LoyaltyCardTransactionDetails**](LoyaltyCardTransactionDetails.md) | | [optional] |
|
|
15
13
|
| **related_transaction_id** | **String** | The related transaction ID on the receiving card. | [optional] |
|
|
16
14
|
| **created_at** | **Time** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
15
|
+
| **details** | [**LoyaltyCardTransactionDetails**](LoyaltyCardTransactionDetails.md) | | [optional] |
|
|
16
|
+
| **type** | [**LoyaltyCardTransactionsType**](LoyaltyCardTransactionsType.md) | | [optional] |
|
|
17
17
|
|
|
@@ -4,10 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** | The type of voucher whose balance is being adjusted due to the transaction. | [optional]
|
|
8
|
-
| **total** | **Integer** | The number of all points accumulated on the card as affected by add or subtract operations. | [optional] |
|
|
7
|
+
| **type** | **String** | The type of voucher whose balance is being adjusted due to the transaction. | [optional] |
|
|
8
|
+
| **total** | **Integer** | The number of all points or credits accumulated on the card as affected by add or subtract operations. | [optional] |
|
|
9
9
|
| **object** | **String** | The type of the object represented by the JSON. | [optional][default to 'balance'] |
|
|
10
|
-
| **points** | **Integer** | Points added or subtracted in the transaction. | [optional] |
|
|
11
|
-
| **balance** | **Integer** | The available points on the card after the transaction as affected by redemption or rollback. | [optional] |
|
|
10
|
+
| **points** | **Integer** | Points added or subtracted in the transaction of a loyalty card. | [optional] |
|
|
11
|
+
| **balance** | **Integer** | The available points or credits on the card after the transaction as affected by redemption or rollback. | [optional] |
|
|
12
|
+
| **operation_type** | **String** | The type of the operation being performed. The operation type is `AUTOMATIC` if it is an automatic redemption. | [optional] |
|
|
12
13
|
| **related_object** | [**LoyaltyCardTransactionDetailsBalanceRelatedObject**](LoyaltyCardTransactionDetailsBalanceRelatedObject.md) | | [optional] |
|
|
13
14
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | Identifies the voucher that is being modified
|
|
7
|
+
| **id** | **String** | Identifies the voucher that is being modified. The ID is assigned by the Voucherify API. | [optional] |
|
|
8
8
|
| **type** | **String** | The object being modified, i.e. voucher. | [optional][default to 'voucher'] |
|
|
9
9
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# VoucherifySdk::LoyaltyPointsBucket
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier of the loyalty points bucket. | [optional] |
|
|
8
|
+
| **voucher_id** | **String** | Unique identifier of the parent loyalty card. | [optional] |
|
|
9
|
+
| **campaign_id** | **String** | Unique identifier of the parent campaign. | [optional] |
|
|
10
|
+
| **bucket** | [**LoyaltyPointsBucketBucket**](LoyaltyPointsBucketBucket.md) | | [optional] |
|
|
11
|
+
| **status** | **String** | Loyalty point point bucket status. | [optional] |
|
|
12
|
+
| **expires_at** | **Time** | Date when the number of points defined in the bucket object are due to expire. | [optional] |
|
|
13
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format. | [optional] |
|
|
14
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format. | [optional] |
|
|
15
|
+
| **object** | **String** | The type of the object represented by JSON. This object stores information about the loyalty point bucket. | [optional][default to 'loyalty_points_bucket'] |
|
|
16
|
+
|