voucherify 8.1.0 → 8.1.1
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 +55 -55
- data/Gemfile.lock +2 -2
- data/README.md +5 -0
- data/docs/CampaignsApi.md +7 -7
- data/docs/ClientSideApi.md +2 -2
- data/docs/CustomersApi.md +5 -5
- data/docs/ErrorError.md +1 -1
- data/docs/ExportParameters.md +2 -2
- data/docs/ExportsApi.md +6 -6
- data/docs/ExportsCreateRequestBodyParameters.md +2 -2
- data/docs/ExportsCreateResponseBodyParameters.md +2 -2
- data/docs/ExportsGetResponseBodyParameters.md +2 -2
- data/docs/LoyaltiesApi.md +52 -52
- data/docs/ManagementApi.md +26 -26
- data/docs/MetadataSchemasApi.md +2 -2
- data/docs/OrdersApi.md +2 -2
- data/docs/ProductCollectionsApi.md +1 -1
- data/docs/ProductsApi.md +4 -4
- data/docs/PublicationsApi.md +3 -3
- data/docs/QualificationsApi.md +1 -1
- data/docs/RedemptionRewardResultParametersCoin.md +1 -1
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -0
- data/docs/ReferralsApi.md +4 -4
- data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
- data/docs/SegmentsApi.md +1 -1
- data/docs/TemplatesApi.md +7 -7
- data/docs/ValidationRulesApi.md +2 -2
- data/docs/ValidationsValidateRequestBodyOptions.md +1 -0
- data/docs/VouchersApi.md +8 -8
- data/lib/VoucherifySdk/api/campaigns_api.rb +14 -14
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +10 -10
- data/lib/VoucherifySdk/api/exports_api.rb +8 -8
- data/lib/VoucherifySdk/api/loyalties_api.rb +104 -104
- data/lib/VoucherifySdk/api/management_api.rb +52 -52
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +4 -4
- data/lib/VoucherifySdk/api/orders_api.rb +4 -4
- data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
- data/lib/VoucherifySdk/api/products_api.rb +8 -8
- data/lib/VoucherifySdk/api/publications_api.rb +6 -6
- data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
- data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
- data/lib/VoucherifySdk/api/referrals_api.rb +8 -8
- data/lib/VoucherifySdk/api/segments_api.rb +2 -2
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +4 -4
- data/lib/VoucherifySdk/api/vouchers_api.rb +16 -16
- data/lib/VoucherifySdk/models/error_error.rb +2 -2
- data/lib/VoucherifySdk/models/export.rb +1 -1
- data/lib/VoucherifySdk/models/export_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/version.rb +1 -1
- metadata +32 -32
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a3cf1f198ad2112652c07ea4a0e9011de0895da7ef2fe69c2022183110408b08
|
|
4
|
+
data.tar.gz: 48fb1272f5d714f144a098201bd097257263ff3799dfe705be4050675e3ed1f0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 821c3eb756e3c574cfe02021a7bea26a85d9f4785e15cb5c4d48107730f89702f17ca116a002f677a975f39d23829dc062050b128ccb9ad809f524335167d434
|
|
7
|
+
data.tar.gz: 053ab34fb13654f2af4d7bfb6ea210af382e42a7a7782e658b536aeddec53d90b761902f60ae70aaf023dd1582a4c739125c4218250c7482045120541a5eed65
|
data/Dockerfile
CHANGED
data/ENDPOINTS-COVERAGE.md
CHANGED
|
@@ -128,61 +128,61 @@
|
|
|
128
128
|
| /v1/rewards/{rewardId}/assignments/{assignmentId} | delete | Delete Reward Assignment | <font color='green'>supported</font> | |
|
|
129
129
|
| /v1/rewards/{rewardId}/assignments/{assignmentId} | get | Get Reward Assignment | <font color='green'>supported</font> | |
|
|
130
130
|
## Loyalties
|
|
131
|
-
| endpoint | method | summary | is supported | is deprecated
|
|
132
|
-
| -------------------------------------------------------------------------- | ------ | ------------------------------------------------- | ------------------------------------ |
|
|
133
|
-
| /v1/loyalties | get | List Loyalty Campaigns | <font color='green'>supported</font> |
|
|
134
|
-
| /v1/loyalties | post | Create Loyalty Campaign | <font color='green'>supported</font> |
|
|
135
|
-
| /v1/loyalties/{campaignId} | get | Get Loyalty Campaign | <font color='green'>supported</font> |
|
|
136
|
-
| /v1/loyalties/{campaignId} | put | Update Loyalty Campaign | <font color='green'>supported</font> |
|
|
137
|
-
| /v1/loyalties/{campaignId} | delete | Delete Loyalty Campaign | <font color='green'>supported</font> |
|
|
138
|
-
| /v1/loyalties/{campaignId}/members | get | List Members | <font color='green'>supported</font> |
|
|
139
|
-
| /v1/loyalties/{campaignId}/members | post | Add Member | <font color='green'>supported</font> |
|
|
140
|
-
| /v1/loyalties/{campaignId}/members/{memberId} | get | Get Member with campaign ID | <font color='green'>supported</font> |
|
|
141
|
-
| /v1/loyalties/members/{memberId} | get | Get Member | <font color='green'>supported</font> |
|
|
142
|
-
| /v1/loyalties/{campaignId}/pending-points | get | List Campaign Pending Points | <font color='green'>supported</font> |
|
|
143
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/pending-points | get | List Member Pending Points with campaign ID | <font color='green'>supported</font> |
|
|
144
|
-
| /v1/loyalties/members/{memberId}/pending-points | get | List Member Pending Points | <font color='green'>supported</font> |
|
|
145
|
-
| /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | post | Activate Member Pending Points | <font color='green'>supported</font> |
|
|
146
|
-
| /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | post | Adjust Member Pending Points | <font color='green'>supported</font> |
|
|
147
|
-
| /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | post | Cancel Member Pending Points | <font color='green'>supported</font> |
|
|
148
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/activity | get | List Member Activity with campaign ID | <font color='green'>supported</font> |
|
|
149
|
-
| /v1/loyalties/members/{memberId}/activity | get | List Member Activity | <font color='green'>supported</font> |
|
|
150
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/balance | post | Adjust Loyalty Card Balance with campaign ID | <font color='green'>supported</font> |
|
|
151
|
-
| /v1/loyalties/members/{memberId}/balance | post | Adjust Loyalty Card Balance | <font color='green'>supported</font> |
|
|
152
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/transfers | post | Transfer Loyalty Points | <font color='green'>supported</font> |
|
|
153
|
-
| /v1/loyalties/{campaignId}/transactions | get | List Loyalty Campaign Transactions | <font color='green'>supported</font> |
|
|
154
|
-
| /v1/loyalties/{campaignId}/transactions/export | post | Export Loyalty Campaign Transactions | <font color='green'>supported</font> |
|
|
155
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/transactions | get | List Loyalty Card Transactions with campaign ID | <font color='green'>supported</font> |
|
|
156
|
-
| /v1/loyalties/members/{memberId}/transactions | get | List Loyalty Card Transactions | <font color='green'>supported</font> |
|
|
157
|
-
| /v1/loyalties/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | <font color='green'>supported</font> |
|
|
158
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions with campaign ID | <font color='green'>supported</font> |
|
|
159
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | get | List Loyalty Card Point Expiration | <font color='green'>supported</font> |
|
|
160
|
-
| /v1/loyalties/{campaignId}/points-expiration/export | post | Export Loyalty Campaign Point Expiration | <font color='green'>supported</font> |
|
|
161
|
-
| /v1/loyalties/{campaignId}/earning-rules | get | List Earning Rules | <font color='green'>supported</font> |
|
|
162
|
-
| /v1/loyalties/{campaignId}/earning-rules | post | Create Earning Rule | <font color='green'>supported</font> |
|
|
163
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | get | Get Earning Rule | <font color='green'>supported</font> |
|
|
164
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | put | Update Earning Rule | <font color='green'>supported</font> |
|
|
165
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | delete | Delete Earning Rule | <font color='green'>supported</font> |
|
|
166
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | post | Enable Earning Rule | <font color='green'>supported</font> |
|
|
167
|
-
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | post | Disable Earning Rule | <font color='green'>supported</font> |
|
|
168
|
-
| /v1/loyalties/members/{memberId}/rewards | get | List Member Rewards | <font color='green'>supported</font> |
|
|
169
|
-
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | get | Get Reward Details | <font color='green'>supported</font> |
|
|
170
|
-
| /v1/loyalties/{campaignId}/reward-assignments | get | List Reward Assignments with campaign ID | <font color='green'>supported</font> |
|
|
171
|
-
| /v1/loyalties/{campaignId}/rewards | get | List Campaign Rewards | <font color='green'>supported</font> |
|
|
172
|
-
| /v1/loyalties/{campaignId}/rewards | post | Create Loyalty Campaign Reward Assignment | <font color='green'>supported</font> |
|
|
173
|
-
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | get | Get Campaign Reward Assignments | <font color='green'>supported</font> |
|
|
174
|
-
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | get | Get Campaign Reward Assignment | <font color='green'>supported</font> |
|
|
175
|
-
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | put | Update Campaign Reward Assignment | <font color='green'>supported</font> |
|
|
176
|
-
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | delete | Delete Campaign Reward Assignment | <font color='green'>supported</font> |
|
|
177
|
-
| /v1/loyalties/{campaignId}/members/{memberId}/redemption | post | Redeem Reward with campaign ID | <font color='green'>supported</font> |
|
|
178
|
-
| /v1/loyalties/members/{memberId}/redemption | post | Redeem Reward | <font color='green'>supported</font> |
|
|
179
|
-
| /v1/loyalties/{campaignId}/tiers | get | List Loyalty Tiers | <font color='green'>supported</font> |
|
|
180
|
-
| /v1/loyalties/{campaignId}/tiers | post | Create loyalty tiers | <font color='green'>supported</font> |
|
|
181
|
-
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | get | Get Loyalty Tier | <font color='green'>supported</font> |
|
|
182
|
-
| /v1/loyalties/members/{memberId}/tiers | get | List Member's Loyalty Tiers | <font color='green'>supported</font> |
|
|
183
|
-
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | get | List Loyalty Tier Earning Rules | <font color='green'>supported</font> |
|
|
184
|
-
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | get | List Loyalty Tier Rewards | <font color='green'>supported</font> |
|
|
185
|
-
| /v1/loyalties/{campaignId}/qualifications | post | Estimate loyalty points | |
|
|
131
|
+
| endpoint | method | summary | is supported | is deprecated |
|
|
132
|
+
| -------------------------------------------------------------------------- | ------ | ------------------------------------------------- | ------------------------------------ | ------------------------------------ |
|
|
133
|
+
| /v1/loyalties | get | List Loyalty Campaigns | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
134
|
+
| /v1/loyalties | post | Create Loyalty Campaign | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
135
|
+
| /v1/loyalties/{campaignId} | get | Get Loyalty Campaign | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
136
|
+
| /v1/loyalties/{campaignId} | put | Update Loyalty Campaign | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
137
|
+
| /v1/loyalties/{campaignId} | delete | Delete Loyalty Campaign | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
138
|
+
| /v1/loyalties/{campaignId}/members | get | List Members | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
139
|
+
| /v1/loyalties/{campaignId}/members | post | Add Member | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
140
|
+
| /v1/loyalties/{campaignId}/members/{memberId} | get | Get Member with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
141
|
+
| /v1/loyalties/members/{memberId} | get | Get Member | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
142
|
+
| /v1/loyalties/{campaignId}/pending-points | get | List Campaign Pending Points | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
143
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/pending-points | get | List Member Pending Points with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
144
|
+
| /v1/loyalties/members/{memberId}/pending-points | get | List Member Pending Points | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
145
|
+
| /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | post | Activate Member Pending Points | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
146
|
+
| /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | post | Adjust Member Pending Points | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
147
|
+
| /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | post | Cancel Member Pending Points | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
148
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/activity | get | List Member Activity with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
149
|
+
| /v1/loyalties/members/{memberId}/activity | get | List Member Activity | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
150
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/balance | post | Adjust Loyalty Card Balance with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
151
|
+
| /v1/loyalties/members/{memberId}/balance | post | Adjust Loyalty Card Balance | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
152
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/transfers | post | Transfer Loyalty Points | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
153
|
+
| /v1/loyalties/{campaignId}/transactions | get | List Loyalty Campaign Transactions | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
154
|
+
| /v1/loyalties/{campaignId}/transactions/export | post | Export Loyalty Campaign Transactions | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
155
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/transactions | get | List Loyalty Card Transactions with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
156
|
+
| /v1/loyalties/members/{memberId}/transactions | get | List Loyalty Card Transactions | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
157
|
+
| /v1/loyalties/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
158
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
159
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | get | List Loyalty Card Point Expiration | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
160
|
+
| /v1/loyalties/{campaignId}/points-expiration/export | post | Export Loyalty Campaign Point Expiration | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
161
|
+
| /v1/loyalties/{campaignId}/earning-rules | get | List Earning Rules | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
162
|
+
| /v1/loyalties/{campaignId}/earning-rules | post | Create Earning Rule | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
163
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | get | Get Earning Rule | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
164
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | put | Update Earning Rule | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
165
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | delete | Delete Earning Rule | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
166
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | post | Enable Earning Rule | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
167
|
+
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | post | Disable Earning Rule | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
168
|
+
| /v1/loyalties/members/{memberId}/rewards | get | List Member Rewards | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
169
|
+
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | get | Get Reward Details | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
170
|
+
| /v1/loyalties/{campaignId}/reward-assignments | get | List Reward Assignments with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
171
|
+
| /v1/loyalties/{campaignId}/rewards | get | List Campaign Rewards | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
172
|
+
| /v1/loyalties/{campaignId}/rewards | post | Create Loyalty Campaign Reward Assignment | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
173
|
+
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | get | Get Campaign Reward Assignments | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
174
|
+
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | get | Get Campaign Reward Assignment | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
175
|
+
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | put | Update Campaign Reward Assignment | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
176
|
+
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | delete | Delete Campaign Reward Assignment | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
177
|
+
| /v1/loyalties/{campaignId}/members/{memberId}/redemption | post | Redeem Reward with campaign ID | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
178
|
+
| /v1/loyalties/members/{memberId}/redemption | post | Redeem Reward | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
179
|
+
| /v1/loyalties/{campaignId}/tiers | get | List Loyalty Tiers | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
180
|
+
| /v1/loyalties/{campaignId}/tiers | post | Create loyalty tiers | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
181
|
+
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | get | Get Loyalty Tier | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
182
|
+
| /v1/loyalties/members/{memberId}/tiers | get | List Member's Loyalty Tiers | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
183
|
+
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | get | List Loyalty Tier Earning Rules | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
184
|
+
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | get | List Loyalty Tier Rewards | <font color='green'>supported</font> | <font color='red'>deprecated</font> |
|
|
185
|
+
| /v1/loyalties/{campaignId}/qualifications | post | Estimate loyalty points | | <font color='red'>deprecated</font> |
|
|
186
186
|
## Customers
|
|
187
187
|
| endpoint | method | summary | is supported | is deprecated |
|
|
188
188
|
| --------------------------------------------- | ------ | ------------------------------------- | ------------------------------------ | ------------------------------------ |
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
voucherify (8.1.
|
|
4
|
+
voucherify (8.1.1)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -29,7 +29,7 @@ GEM
|
|
|
29
29
|
pry-byebug (3.10.1)
|
|
30
30
|
byebug (~> 11.0)
|
|
31
31
|
pry (>= 0.13, < 0.15)
|
|
32
|
-
psych (5.
|
|
32
|
+
psych (5.5.0)
|
|
33
33
|
date
|
|
34
34
|
stringio
|
|
35
35
|
racc (1.8.1)
|
data/README.md
CHANGED
|
@@ -197,6 +197,11 @@ end
|
|
|
197
197
|
- **Location**: HTTP header
|
|
198
198
|
|
|
199
199
|
## 📅 Changelog
|
|
200
|
+
- **2026-08-26** - `8.1.1`
|
|
201
|
+
- Fixed: `exchange_ratio` is `Float` on COIN reward models (create/update were `String`, `RedemptionRewardResultParametersCoin` was `Integer`). The API returns fractional values such as `0.01`.
|
|
202
|
+
- Added: `language` on `RedemptionsRedeemRequestBodyOptions` and `ValidationsValidateRequestBodyOptions`.
|
|
203
|
+
- Added: product/sku export order and field values (`product_id`, `sku`, `price`, `image_url`, `attributes`, `currency`).
|
|
204
|
+
- Note: `ErrorError.message` is the resolved custom validation-rule error for `options.language`, falling back to the Error Message Library default language.
|
|
200
205
|
- **2026-07-30** - `8.1.0`
|
|
201
206
|
- Added support for **GET** /v1/campaigns/{campaignId}/summary
|
|
202
207
|
- Added support for **GET** /v1/campaigns/{campaignId}/transactions
|
data/docs/CampaignsApi.md
CHANGED
|
@@ -154,7 +154,7 @@ end
|
|
|
154
154
|
|
|
155
155
|
Create Campaign
|
|
156
156
|
|
|
157
|
-
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.
|
|
157
|
+
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. <Note> <Badge color blue>Global uniqueness</Badge> All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. </Note> <Warning> <Badge color yellow>Code generation status</Badge> 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](/api-reference/campaigns/campaign-object) description. </Warning>
|
|
158
158
|
|
|
159
159
|
### Examples
|
|
160
160
|
|
|
@@ -276,7 +276,7 @@ end
|
|
|
276
276
|
|
|
277
277
|
Disable Campaign
|
|
278
278
|
|
|
279
|
-
|
|
279
|
+
Sets campaign state to **inactive**. The vouchers in this campaign can no longer be redeemed.
|
|
280
280
|
|
|
281
281
|
### Examples
|
|
282
282
|
|
|
@@ -334,7 +334,7 @@ end
|
|
|
334
334
|
|
|
335
335
|
Enable Campaign
|
|
336
336
|
|
|
337
|
-
|
|
337
|
+
Sets campaign state to **active**. The vouchers in this campaign can be redeemed - only if the redemption occurs after the start date of the campaign and voucher and the voucher and campaign are not expired.
|
|
338
338
|
|
|
339
339
|
### Examples
|
|
340
340
|
|
|
@@ -392,7 +392,7 @@ end
|
|
|
392
392
|
|
|
393
393
|
Export Campaign Transactions
|
|
394
394
|
|
|
395
|
-
Export transactions is an asynchronous process that generates a CSV file with the data about credit movements on all gift cards or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows:
|
|
395
|
+
Export transactions is an asynchronous process that generates a CSV file with the data about credit movements on all gift cards or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: <Tip> <Badge color green>Export Loyalty Campaign Transactions</Badge> For loyalty campaigns, this method works in the same way the [POST Export Loyalty Campaign Transactions](/api-reference/loyalties/export-loyalty-campaign-transactions) does. </Tip>
|
|
396
396
|
|
|
397
397
|
### Examples
|
|
398
398
|
|
|
@@ -512,7 +512,7 @@ end
|
|
|
512
512
|
|
|
513
513
|
Get Campaign Summary
|
|
514
514
|
|
|
515
|
-
Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type. Use start_date and end_date to narrow down the data to specific periods.
|
|
515
|
+
Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type. Use start_date and end_date to narrow down the data to specific periods. <Warning> <Badge color yellow>Campaigns created before 17 June 2025</Badge> This endpoint returns analytics data for campaigns that were created after 17 June 2025. Older campaigns return empty data. </Warning>
|
|
516
516
|
|
|
517
517
|
### Examples
|
|
518
518
|
|
|
@@ -700,7 +700,7 @@ end
|
|
|
700
700
|
|
|
701
701
|
List Campaign Transactions
|
|
702
702
|
|
|
703
|
-
Retrieves all transactions for the campaign with the given campaign ID or campaign name. The id filter denotes the unique transaction identifier.
|
|
703
|
+
Retrieves all transactions for the campaign with the given campaign ID or campaign name. The id filter denotes the unique transaction identifier. <Warning> The endpoint works only for gift card and loyalty campaigns. </Warning>
|
|
704
704
|
|
|
705
705
|
### Examples
|
|
706
706
|
|
|
@@ -838,7 +838,7 @@ end
|
|
|
838
838
|
|
|
839
839
|
Update Campaign
|
|
840
840
|
|
|
841
|
-
Updates the specified campaign by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.
|
|
841
|
+
Updates the specified campaign by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped. <Warning> <Badge color yellow>Vouchers will be affected</Badge> This method will update vouchers aggregated in the campaign. It will affect all vouchers that are not published or redeemed yet. </Warning>
|
|
842
842
|
|
|
843
843
|
### Examples
|
|
844
844
|
|
data/docs/ClientSideApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
17
17
|
|
|
18
18
|
Check Eligibility (client-side)
|
|
19
19
|
|
|
20
|
-
Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version
|
|
20
|
+
Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version <Tip> <Badge color green>Scenario Guide</Badge> Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). </Tip> # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. # Caching Qualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -145,7 +145,7 @@ end
|
|
|
145
145
|
|
|
146
146
|
Redeem Stackable Discounts (client-side)
|
|
147
147
|
|
|
148
|
-
This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:
|
|
148
|
+
This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: <Note> <Badge color blue>Rollbacks</Badge> You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). </Note>
|
|
149
149
|
|
|
150
150
|
### Examples
|
|
151
151
|
|
data/docs/CustomersApi.md
CHANGED
|
@@ -25,7 +25,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
25
25
|
|
|
26
26
|
Create Customer
|
|
27
27
|
|
|
28
|
-
Creates a customer object.
|
|
28
|
+
Creates a customer object. <Note> <Badge color blue>Upsert Mode</Badge> If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. </Note>
|
|
29
29
|
|
|
30
30
|
### Examples
|
|
31
31
|
|
|
@@ -85,7 +85,7 @@ end
|
|
|
85
85
|
|
|
86
86
|
Delete Customer Permanently
|
|
87
87
|
|
|
88
|
-
The organization user can remove
|
|
88
|
+
The organization user can remove customer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify as per the GDPR.
|
|
89
89
|
|
|
90
90
|
### Examples
|
|
91
91
|
|
|
@@ -143,7 +143,7 @@ end
|
|
|
143
143
|
|
|
144
144
|
Delete Customer
|
|
145
145
|
|
|
146
|
-
This method deletes a customer.
|
|
146
|
+
This method deletes a customer. The customer is permanently deleted. This means that a new customer with the same source_id can be created. <Note> <Badge color blue>GDPR compliance</Badge> This method does NOT delete all related data, including personal data, from Voucherify databases. To delete these records and fulfil the right to be forgotten in the sense of the GDPR, use the [Delete Customer Permanently](/api-reference/customers/delete-customer-permanently) endpoint or go to [Delete people data](/manage/team-settings#delete-people-data) in the Voucherify [Team settings](/manage/team-settings). </Note>
|
|
147
147
|
|
|
148
148
|
### Examples
|
|
149
149
|
|
|
@@ -258,7 +258,7 @@ end
|
|
|
258
258
|
|
|
259
259
|
Import and Update Customers using CSV
|
|
260
260
|
|
|
261
|
-
This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object.
|
|
261
|
+
This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. <Note> <Badge color blue>Standard customer fields mapping</Badge> **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 </Note> # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
|
|
262
262
|
|
|
263
263
|
### Examples
|
|
264
264
|
|
|
@@ -318,7 +318,7 @@ end
|
|
|
318
318
|
|
|
319
319
|
List Customer Activities
|
|
320
320
|
|
|
321
|
-
>
|
|
321
|
+
<Danger> <Badge color red>Deprecated</Badge> This endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint. </Danger> Retrieve customer activities.
|
|
322
322
|
|
|
323
323
|
### Examples
|
|
324
324
|
|
data/docs/ErrorError.md
CHANGED
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message** | **String** |
|
|
7
|
+
| **message** | **String** | Resolved custom validation-rule error message for `options.language`, falling back to the Error Message Library default language. Present only when a custom message can be resolved. | [optional] |
|
|
8
8
|
|
data/docs/ExportParameters.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **order** | **String** | | [optional] |
|
|
8
|
-
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
|
|
9
|
-
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
|
|
8
|
+
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. and Array of strings containing the data in the export. These fields define the headers in the CSV file. The `metadata` field expands into one CSV column per metadata property. You can also pass specific properties as `metadata.<property_name>`. | [optional] |
|
|
9
|
+
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" and Allowed additional properties must start with \"metadata.\" or \"attributes.\" | [optional] |
|
|
10
10
|
| **campaign_id** | **String** | Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. | [optional] |
|
|
11
11
|
|
data/docs/ExportsApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
17
17
|
|
|
18
18
|
Create Export
|
|
19
19
|
|
|
20
|
-
Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object:
|
|
20
|
+
Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: <Note> <Badge color blue>Date and time in the export API</Badge> The exported date and times are always provided in the UTC time zone. </Note> # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions # Products # SKUs
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -98,7 +98,7 @@ VoucherifySdk.configure do |config|
|
|
|
98
98
|
end
|
|
99
99
|
|
|
100
100
|
api_instance = VoucherifySdk::ExportsApi.new
|
|
101
|
-
export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or
|
|
101
|
+
export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.
|
|
102
102
|
|
|
103
103
|
begin
|
|
104
104
|
# Delete Export
|
|
@@ -112,7 +112,7 @@ end
|
|
|
112
112
|
|
|
113
113
|
| Name | Type | Description | Notes |
|
|
114
114
|
| ---- | ---- | ----------- | ----- |
|
|
115
|
-
| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or
|
|
115
|
+
| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. | |
|
|
116
116
|
|
|
117
117
|
### Return type
|
|
118
118
|
|
|
@@ -134,7 +134,7 @@ nil (empty response body)
|
|
|
134
134
|
|
|
135
135
|
Download Export
|
|
136
136
|
|
|
137
|
-
Download the contents of the exported CSV file.
|
|
137
|
+
Download the contents of the exported CSV file. <Note> <Badge color blue>Important notes</Badge> **Base URL:** - https://download.voucherify.io (Europe) - https://us1.download.voucherify.io (US) - https://as1.download.voucherify.io (Asia) **Token:** Can be found within the result parameter of the [Get Export](/api-reference/exports/get-export) method response. </Note>
|
|
138
138
|
|
|
139
139
|
### Examples
|
|
140
140
|
|
|
@@ -217,7 +217,7 @@ VoucherifySdk.configure do |config|
|
|
|
217
217
|
end
|
|
218
218
|
|
|
219
219
|
api_instance = VoucherifySdk::ExportsApi.new
|
|
220
|
-
export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or
|
|
220
|
+
export_id = 'export_id_example' # String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.
|
|
221
221
|
|
|
222
222
|
begin
|
|
223
223
|
# Get Export
|
|
@@ -232,7 +232,7 @@ end
|
|
|
232
232
|
|
|
233
233
|
| Name | Type | Description | Notes |
|
|
234
234
|
| ---- | ---- | ----------- | ----- |
|
|
235
|
-
| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or
|
|
235
|
+
| **export_id** | **String** | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. | |
|
|
236
236
|
|
|
237
237
|
### Return type
|
|
238
238
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **order** | **String** | | [optional] |
|
|
8
|
-
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
|
|
9
|
-
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
|
|
8
|
+
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. and Array of strings containing the data in the export. These fields define the headers in the CSV file. The `metadata` field expands into one CSV column per metadata property. You can also pass specific properties as `metadata.<property_name>`. | [optional] |
|
|
9
|
+
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" and Allowed additional properties must start with \"metadata.\" or \"attributes.\" | [optional] |
|
|
10
10
|
| **campaign_id** | **String** | Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. | [optional] |
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **order** | **String** | | [optional] |
|
|
8
|
-
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
|
|
9
|
-
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
|
|
8
|
+
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. and Array of strings containing the data in the export. These fields define the headers in the CSV file. The `metadata` field expands into one CSV column per metadata property. You can also pass specific properties as `metadata.<property_name>`. | [optional] |
|
|
9
|
+
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" and Allowed additional properties must start with \"metadata.\" or \"attributes.\" | [optional] |
|
|
10
10
|
| **campaign_id** | **String** | Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. | [optional] |
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **order** | **String** | | [optional] |
|
|
8
|
-
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
|
|
9
|
-
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] |
|
|
8
|
+
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. and Array of strings containing the data in the export. These fields define the headers in the CSV file. The `metadata` field expands into one CSV column per metadata property. You can also pass specific properties as `metadata.<property_name>`. | [optional] |
|
|
9
|
+
| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" and Allowed additional properties must start with \"metadata.\" or \"attributes.\" | [optional] |
|
|
10
10
|
| **campaign_id** | **String** | Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. | [optional] |
|
|
11
11
|
|