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
|
@@ -20,7 +20,7 @@ module VoucherifySdk
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add Promotion Tier From Template
|
|
23
|
-
# Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment).
|
|
23
|
+
# Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment). <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
24
24
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [TemplatesCampaignsTierSetupCreateRequestBody] :templates_campaigns_tier_setup_create_request_body Only name and campaign_id are required. The rest of the fields will overwrite the template configuration.
|
|
@@ -31,7 +31,7 @@ module VoucherifySdk
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Add Promotion Tier From Template
|
|
34
|
-
# Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment).
|
|
34
|
+
# Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment). <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
35
35
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [TemplatesCampaignsTierSetupCreateRequestBody] :templates_campaigns_tier_setup_create_request_body Only name and campaign_id are required. The rest of the fields will overwrite the template configuration.
|
|
@@ -86,7 +86,7 @@ module VoucherifySdk
|
|
|
86
86
|
end
|
|
87
87
|
|
|
88
88
|
# Create Campaign From Template
|
|
89
|
-
# Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments).
|
|
89
|
+
# Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments). <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
90
90
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
91
91
|
# @param [Hash] opts the optional parameters
|
|
92
92
|
# @option opts [TemplatesCampaignsCampaignSetupCreateRequestBody] :templates_campaigns_campaign_setup_create_request_body Only name is required. The rest of the fields will overwrite the template configuration.
|
|
@@ -97,7 +97,7 @@ module VoucherifySdk
|
|
|
97
97
|
end
|
|
98
98
|
|
|
99
99
|
# Create Campaign From Template
|
|
100
|
-
# Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments).
|
|
100
|
+
# Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments). <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
101
101
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
102
102
|
# @param [Hash] opts the optional parameters
|
|
103
103
|
# @option opts [TemplatesCampaignsCampaignSetupCreateRequestBody] :templates_campaigns_campaign_setup_create_request_body Only name is required. The rest of the fields will overwrite the template configuration.
|
|
@@ -152,7 +152,7 @@ module VoucherifySdk
|
|
|
152
152
|
end
|
|
153
153
|
|
|
154
154
|
# Create Campaign Template
|
|
155
|
-
# Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments
|
|
155
|
+
# Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
156
156
|
# @param [Hash] opts the optional parameters
|
|
157
157
|
# @option opts [TemplatesCampaignsCreateRequestBody] :templates_campaigns_create_request_body Provide details for a campaign template
|
|
158
158
|
# @return [TemplatesCampaignsCreateTemplateResponseBody]
|
|
@@ -162,7 +162,7 @@ module VoucherifySdk
|
|
|
162
162
|
end
|
|
163
163
|
|
|
164
164
|
# Create Campaign Template
|
|
165
|
-
# Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments
|
|
165
|
+
# Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
166
166
|
# @param [Hash] opts the optional parameters
|
|
167
167
|
# @option opts [TemplatesCampaignsCreateRequestBody] :templates_campaigns_create_request_body Provide details for a campaign template
|
|
168
168
|
# @return [Array<(TemplatesCampaignsCreateTemplateResponseBody, Integer, Hash)>] TemplatesCampaignsCreateTemplateResponseBody data, response status code and response headers
|
|
@@ -216,7 +216,7 @@ module VoucherifySdk
|
|
|
216
216
|
end
|
|
217
217
|
|
|
218
218
|
# Delete Campaign Template
|
|
219
|
-
# Deletes the campaign template permanently.
|
|
219
|
+
# Deletes the campaign template permanently. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
220
220
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
221
221
|
# @param [Hash] opts the optional parameters
|
|
222
222
|
# @return [nil]
|
|
@@ -226,7 +226,7 @@ module VoucherifySdk
|
|
|
226
226
|
end
|
|
227
227
|
|
|
228
228
|
# Delete Campaign Template
|
|
229
|
-
# Deletes the campaign template permanently.
|
|
229
|
+
# Deletes the campaign template permanently. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
230
230
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
231
231
|
# @param [Hash] opts the optional parameters
|
|
232
232
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -273,7 +273,7 @@ module VoucherifySdk
|
|
|
273
273
|
end
|
|
274
274
|
|
|
275
275
|
# Get Campaign Template
|
|
276
|
-
# Retrieves a campaign template available in the project.
|
|
276
|
+
# Retrieves a campaign template available in the project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
277
277
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
278
278
|
# @param [Hash] opts the optional parameters
|
|
279
279
|
# @return [TemplatesCampaignsGetResponseBody]
|
|
@@ -283,7 +283,7 @@ module VoucherifySdk
|
|
|
283
283
|
end
|
|
284
284
|
|
|
285
285
|
# Get Campaign Template
|
|
286
|
-
# Retrieves a campaign template available in the project.
|
|
286
|
+
# Retrieves a campaign template available in the project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
287
287
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
288
288
|
# @param [Hash] opts the optional parameters
|
|
289
289
|
# @return [Array<(TemplatesCampaignsGetResponseBody, Integer, Hash)>] TemplatesCampaignsGetResponseBody data, response status code and response headers
|
|
@@ -332,7 +332,7 @@ module VoucherifySdk
|
|
|
332
332
|
end
|
|
333
333
|
|
|
334
334
|
# List Campaign Templates
|
|
335
|
-
# Lists all campaign templates available in the project.
|
|
335
|
+
# Lists all campaign templates available in the project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
336
336
|
# @param [Hash] opts the optional parameters
|
|
337
337
|
# @option opts [Integer] :limit 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.
|
|
338
338
|
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the campaign templates created after a template with the given ID.
|
|
@@ -346,7 +346,7 @@ module VoucherifySdk
|
|
|
346
346
|
end
|
|
347
347
|
|
|
348
348
|
# List Campaign Templates
|
|
349
|
-
# Lists all campaign templates available in the project.
|
|
349
|
+
# Lists all campaign templates available in the project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
350
350
|
# @param [Hash] opts the optional parameters
|
|
351
351
|
# @option opts [Integer] :limit 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.
|
|
352
352
|
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the campaign templates created after a template with the given ID.
|
|
@@ -404,7 +404,7 @@ module VoucherifySdk
|
|
|
404
404
|
end
|
|
405
405
|
|
|
406
406
|
# Update Campaign Template
|
|
407
|
-
# Updates the name or description of the campaign template.
|
|
407
|
+
# Updates the name or description of the campaign template. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
408
408
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
409
409
|
# @param [Hash] opts the optional parameters
|
|
410
410
|
# @option opts [TemplatesCampaignsUpdateRequestBody] :templates_campaigns_update_request_body Provide the new name or description for the campaign template
|
|
@@ -415,7 +415,7 @@ module VoucherifySdk
|
|
|
415
415
|
end
|
|
416
416
|
|
|
417
417
|
# Update Campaign Template
|
|
418
|
-
# Updates the name or description of the campaign template.
|
|
418
|
+
# Updates the name or description of the campaign template. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
419
419
|
# @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
|
|
420
420
|
# @param [Hash] opts the optional parameters
|
|
421
421
|
# @option opts [TemplatesCampaignsUpdateRequestBody] :templates_campaigns_update_request_body Provide the new name or description for the campaign template
|
|
@@ -89,7 +89,7 @@ module VoucherifySdk
|
|
|
89
89
|
end
|
|
90
90
|
|
|
91
91
|
# Create Validation Rules
|
|
92
|
-
# Create a validation rule.
|
|
92
|
+
# Create a validation rule. <Warning> <Badge color yellow>Managing validation rules</Badge> It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. </Warning>
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @option opts [ValidationRulesCreateRequestBody] :validation_rules_create_request_body Specify the validation rules parameters.
|
|
95
95
|
# @return [ValidationRulesCreateResponseBody]
|
|
@@ -99,7 +99,7 @@ module VoucherifySdk
|
|
|
99
99
|
end
|
|
100
100
|
|
|
101
101
|
# Create Validation Rules
|
|
102
|
-
# Create a validation rule.
|
|
102
|
+
# Create a validation rule. <Warning> <Badge color yellow>Managing validation rules</Badge> It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. </Warning>
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
104
104
|
# @option opts [ValidationRulesCreateRequestBody] :validation_rules_create_request_body Specify the validation rules parameters.
|
|
105
105
|
# @return [Array<(ValidationRulesCreateResponseBody, Integer, Hash)>] ValidationRulesCreateResponseBody data, response status code and response headers
|
|
@@ -540,7 +540,7 @@ module VoucherifySdk
|
|
|
540
540
|
end
|
|
541
541
|
|
|
542
542
|
# Update Validation Rule
|
|
543
|
-
# Update validation rule parameters.
|
|
543
|
+
# Update validation rule parameters. <Warning> <Badge color yellow>Managing validation rules</Badge> It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. </Warning>
|
|
544
544
|
# @param validation_rule_id [String] A unique validation rule ID.
|
|
545
545
|
# @param [Hash] opts the optional parameters
|
|
546
546
|
# @option opts [ValidationRulesUpdateRequestBody] :validation_rules_update_request_body Specify the parameters to be updated.
|
|
@@ -551,7 +551,7 @@ module VoucherifySdk
|
|
|
551
551
|
end
|
|
552
552
|
|
|
553
553
|
# Update Validation Rule
|
|
554
|
-
# Update validation rule parameters.
|
|
554
|
+
# Update validation rule parameters. <Warning> <Badge color yellow>Managing validation rules</Badge> It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. </Warning>
|
|
555
555
|
# @param validation_rule_id [String] A unique validation rule ID.
|
|
556
556
|
# @param [Hash] opts the optional parameters
|
|
557
557
|
# @option opts [ValidationRulesUpdateRequestBody] :validation_rules_update_request_body Specify the parameters to be updated.
|
|
@@ -20,7 +20,7 @@ module VoucherifySdk
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Voucher
|
|
23
|
-
# Create a generic (standalone) voucher or a voucher in a campaign. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. If no campaign name or campaign_id is provided, the new voucher will be a generic (standalone) one. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to this campaign. For a loyalty card, a campaign name or ID is required.
|
|
23
|
+
# Create a generic (standalone) voucher or a voucher in a campaign. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. If no campaign name or campaign_id is provided, the new voucher will be a generic (standalone) one. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to this campaign. For a loyalty card, a campaign name or ID is required. <Warning> <Badge color yellow>Standalone Vouchers and Campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers created through The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint. </Warning>
|
|
24
24
|
# @param code [String] A unique **code** that identifies the voucher.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [VouchersCreateWithSpecificCodeRequestBody] :vouchers_create_with_specific_code_request_body Specify the details of the voucher that you would like to create.
|
|
@@ -31,7 +31,7 @@ module VoucherifySdk
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Create Voucher
|
|
34
|
-
# Create a generic (standalone) voucher or a voucher in a campaign. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. If no campaign name or campaign_id is provided, the new voucher will be a generic (standalone) one. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to this campaign. For a loyalty card, a campaign name or ID is required.
|
|
34
|
+
# Create a generic (standalone) voucher or a voucher in a campaign. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. If no campaign name or campaign_id is provided, the new voucher will be a generic (standalone) one. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to this campaign. For a loyalty card, a campaign name or ID is required. <Warning> <Badge color yellow>Standalone Vouchers and Campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers created through The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint. </Warning>
|
|
35
35
|
# @param code [String] A unique **code** that identifies the voucher.
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [VouchersCreateWithSpecificCodeRequestBody] :vouchers_create_with_specific_code_request_body Specify the details of the voucher that you would like to create.
|
|
@@ -146,7 +146,7 @@ module VoucherifySdk
|
|
|
146
146
|
end
|
|
147
147
|
|
|
148
148
|
# Disable Voucher
|
|
149
|
-
#
|
|
149
|
+
# This method sets the voucher state to **inactive**. The voucher cannot be redeemed.
|
|
150
150
|
# @param code [String] A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
|
|
151
151
|
# @param [Hash] opts the optional parameters
|
|
152
152
|
# @return [VouchersDisableResponseBody]
|
|
@@ -156,7 +156,7 @@ module VoucherifySdk
|
|
|
156
156
|
end
|
|
157
157
|
|
|
158
158
|
# Disable Voucher
|
|
159
|
-
#
|
|
159
|
+
# This method sets the voucher state to **inactive**. The voucher cannot be redeemed.
|
|
160
160
|
# @param code [String] A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
|
|
161
161
|
# @param [Hash] opts the optional parameters
|
|
162
162
|
# @return [Array<(VouchersDisableResponseBody, Integer, Hash)>] VouchersDisableResponseBody data, response status code and response headers
|
|
@@ -205,7 +205,7 @@ module VoucherifySdk
|
|
|
205
205
|
end
|
|
206
206
|
|
|
207
207
|
# Enable Voucher
|
|
208
|
-
#
|
|
208
|
+
# The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
|
|
209
209
|
# @param code [String] A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
|
|
210
210
|
# @param [Hash] opts the optional parameters
|
|
211
211
|
# @return [VouchersEnableResponseBody]
|
|
@@ -215,7 +215,7 @@ module VoucherifySdk
|
|
|
215
215
|
end
|
|
216
216
|
|
|
217
217
|
# Enable Voucher
|
|
218
|
-
#
|
|
218
|
+
# The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
|
|
219
219
|
# @param code [String] A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
|
|
220
220
|
# @param [Hash] opts the optional parameters
|
|
221
221
|
# @return [Array<(VouchersEnableResponseBody, Integer, Hash)>] VouchersEnableResponseBody data, response status code and response headers
|
|
@@ -330,7 +330,7 @@ module VoucherifySdk
|
|
|
330
330
|
end
|
|
331
331
|
|
|
332
332
|
# Generate Random Code
|
|
333
|
-
# Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists.
|
|
333
|
+
# Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. <Warning> <Badge color yellow>Standalone Vouchers and Campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint. </Warning>
|
|
334
334
|
# @param [Hash] opts the optional parameters
|
|
335
335
|
# @option opts [VouchersCreateRequestBody] :vouchers_create_request_body Specify the details of the voucher that you would like to create.
|
|
336
336
|
# @return [VouchersCreateResponseBody]
|
|
@@ -340,7 +340,7 @@ module VoucherifySdk
|
|
|
340
340
|
end
|
|
341
341
|
|
|
342
342
|
# Generate Random Code
|
|
343
|
-
# Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists.
|
|
343
|
+
# Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. <Warning> <Badge color yellow>Standalone Vouchers and Campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint. </Warning>
|
|
344
344
|
# @param [Hash] opts the optional parameters
|
|
345
345
|
# @option opts [VouchersCreateRequestBody] :vouchers_create_request_body Specify the details of the voucher that you would like to create.
|
|
346
346
|
# @return [Array<(VouchersCreateResponseBody, Integer, Hash)>] VouchersCreateResponseBody data, response status code and response headers
|
|
@@ -453,7 +453,7 @@ module VoucherifySdk
|
|
|
453
453
|
end
|
|
454
454
|
|
|
455
455
|
# Import Vouchers
|
|
456
|
-
# Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data.
|
|
456
|
+
# Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. <Note> <Badge color blue>Important notes</Badge> - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. </Note> Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. 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). <Warning> <Badge color yellow>Standalone Vouchers and Campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint. </Warning>
|
|
457
457
|
# @param vouchers_import_create_item_request_body [Array<VouchersImportCreateItemRequestBody>] The request body is an array of objects. Each object contains details about a specific voucher.
|
|
458
458
|
# @param [Hash] opts the optional parameters
|
|
459
459
|
# @return [VouchersImportCreateResponseBody]
|
|
@@ -463,7 +463,7 @@ module VoucherifySdk
|
|
|
463
463
|
end
|
|
464
464
|
|
|
465
465
|
# Import Vouchers
|
|
466
|
-
# Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data.
|
|
466
|
+
# Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. <Note> <Badge color blue>Important notes</Badge> - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. </Note> Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. 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). <Warning> <Badge color yellow>Standalone Vouchers and Campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint. </Warning>
|
|
467
467
|
# @param vouchers_import_create_item_request_body [Array<VouchersImportCreateItemRequestBody>] The request body is an array of objects. Each object contains details about a specific voucher.
|
|
468
468
|
# @param [Hash] opts the optional parameters
|
|
469
469
|
# @return [Array<(VouchersImportCreateResponseBody, Integer, Hash)>] VouchersImportCreateResponseBody data, response status code and response headers
|
|
@@ -517,7 +517,7 @@ module VoucherifySdk
|
|
|
517
517
|
end
|
|
518
518
|
|
|
519
519
|
# Import Vouchers using CSV
|
|
520
|
-
# Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](/build/discount-code-import). ___
|
|
520
|
+
# Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](/build/discount-code-import). ___ <Note> <Badge color blue>Standard voucher fields mapping</Badge> - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. </Note> <Note> <Badge color blue>Categories</Badge> In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. </Note> 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). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. <Warning> <Badge color yellow>Generic (standalone) vouchers and campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. </Warning>
|
|
521
521
|
# @param [Hash] opts the optional parameters
|
|
522
522
|
# @option opts [File] :file File path.
|
|
523
523
|
# @option opts [Boolean] :webhooks_enable Triggers a webhook sendout for new and updated vouchers if the voucher created and voucher updated webhooks are configured in Project settings.
|
|
@@ -528,7 +528,7 @@ module VoucherifySdk
|
|
|
528
528
|
end
|
|
529
529
|
|
|
530
530
|
# Import Vouchers using CSV
|
|
531
|
-
# Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](/build/discount-code-import). ___
|
|
531
|
+
# Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](/build/discount-code-import). ___ <Note> <Badge color blue>Standard voucher fields mapping</Badge> - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. </Note> <Note> <Badge color blue>Categories</Badge> In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. </Note> 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). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. <Warning> <Badge color yellow>Generic (standalone) vouchers and campaigns</Badge> Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. </Warning>
|
|
532
532
|
# @param [Hash] opts the optional parameters
|
|
533
533
|
# @option opts [File] :file File path.
|
|
534
534
|
# @option opts [Boolean] :webhooks_enable Triggers a webhook sendout for new and updated vouchers if the voucher created and voucher updated webhooks are configured in Project settings.
|
|
@@ -743,7 +743,7 @@ module VoucherifySdk
|
|
|
743
743
|
end
|
|
744
744
|
|
|
745
745
|
# Release Validation Session
|
|
746
|
-
# Manually release a validation session that has been set up for the voucher. This method undoes the actions that are explained in the [Locking validation session](/guides/locking-validation-session) guide.
|
|
746
|
+
# Manually release a validation session that has been set up for the voucher. This method undoes the actions that are explained in the [Locking validation session](/guides/locking-validation-session) guide. <Note> <Badge color blue>Release session in the Dashboard</Badge> You can also use the [Validations Manager](/optimize/validations-and-redemptions#sessions) in the Dashboard to unlock sessions. </Note>
|
|
747
747
|
# @param code [String] A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify.
|
|
748
748
|
# @param session_key [String] A unique session identifier.
|
|
749
749
|
# @param [Hash] opts the optional parameters
|
|
@@ -754,7 +754,7 @@ module VoucherifySdk
|
|
|
754
754
|
end
|
|
755
755
|
|
|
756
756
|
# Release Validation Session
|
|
757
|
-
# Manually release a validation session that has been set up for the voucher. This method undoes the actions that are explained in the [Locking validation session](/guides/locking-validation-session) guide.
|
|
757
|
+
# Manually release a validation session that has been set up for the voucher. This method undoes the actions that are explained in the [Locking validation session](/guides/locking-validation-session) guide. <Note> <Badge color blue>Release session in the Dashboard</Badge> You can also use the [Validations Manager](/optimize/validations-and-redemptions#sessions) in the Dashboard to unlock sessions. </Note>
|
|
758
758
|
# @param code [String] A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify.
|
|
759
759
|
# @param session_key [String] A unique session identifier.
|
|
760
760
|
# @param [Hash] opts the optional parameters
|
|
@@ -934,7 +934,7 @@ module VoucherifySdk
|
|
|
934
934
|
end
|
|
935
935
|
|
|
936
936
|
# Update Vouchers in Bulk
|
|
937
|
-
# Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported.
|
|
937
|
+
# Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. <Warning> Currently, only **metadata** updates are supported. </Warning> The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
938
938
|
# @param vouchers_update_in_bulk_item_request_body [Array<VouchersUpdateInBulkItemRequestBody>] List the codes to be updated with the metadata key/value pairs for that code.
|
|
939
939
|
# @param [Hash] opts the optional parameters
|
|
940
940
|
# @return [VouchersUpdateInBulkResponseBody]
|
|
@@ -944,7 +944,7 @@ module VoucherifySdk
|
|
|
944
944
|
end
|
|
945
945
|
|
|
946
946
|
# Update Vouchers in Bulk
|
|
947
|
-
# Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported.
|
|
947
|
+
# Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. <Warning> Currently, only **metadata** updates are supported. </Warning> The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
948
948
|
# @param vouchers_update_in_bulk_item_request_body [Array<VouchersUpdateInBulkItemRequestBody>] List the codes to be updated with the metadata key/value pairs for that code.
|
|
949
949
|
# @param [Hash] opts the optional parameters
|
|
950
950
|
# @return [Array<(VouchersUpdateInBulkResponseBody, Integer, Hash)>] VouchersUpdateInBulkResponseBody data, response status code and response headers
|
|
@@ -14,9 +14,9 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module VoucherifySdk
|
|
17
|
-
# Includes
|
|
17
|
+
# Includes the resolved custom validation-rule error message when one is configured.
|
|
18
18
|
class ErrorError
|
|
19
|
-
#
|
|
19
|
+
# 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.
|
|
20
20
|
attr_accessor :message
|
|
21
21
|
|
|
22
22
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -174,7 +174,7 @@ module VoucherifySdk
|
|
|
174
174
|
return false unless object_validator.valid?(@object)
|
|
175
175
|
status_validator = EnumAttributeValidator.new('String', ["SCHEDULED", "IN_PROGRESS", "DONE", "ERROR"])
|
|
176
176
|
return false unless status_validator.valid?(@status)
|
|
177
|
-
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions"])
|
|
177
|
+
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions", "product", "sku"])
|
|
178
178
|
return false unless exported_object_validator.valid?(@exported_object)
|
|
179
179
|
true
|
|
180
180
|
end
|
|
@@ -17,10 +17,10 @@ module VoucherifySdk
|
|
|
17
17
|
class ExportParameters
|
|
18
18
|
attr_accessor :order
|
|
19
19
|
|
|
20
|
-
# Array of strings containing the data in the export. These fields define the headers in the CSV file.
|
|
20
|
+
# 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>`.
|
|
21
21
|
attr_accessor :fields
|
|
22
22
|
|
|
23
|
-
# 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.\"
|
|
23
|
+
# 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.\"
|
|
24
24
|
attr_accessor :filters
|
|
25
25
|
|
|
26
26
|
# Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered.
|
|
@@ -122,7 +122,7 @@ module VoucherifySdk
|
|
|
122
122
|
# @return true if the model is valid
|
|
123
123
|
def valid?
|
|
124
124
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
125
|
-
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at"])
|
|
125
|
+
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at", "-product_id", "product_id", "-sku", "sku"])
|
|
126
126
|
return false unless order_validator.valid?(@order)
|
|
127
127
|
true
|
|
128
128
|
end
|
|
@@ -99,7 +99,7 @@ module VoucherifySdk
|
|
|
99
99
|
# @return true if the model is valid
|
|
100
100
|
def valid?
|
|
101
101
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
102
|
-
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions"])
|
|
102
|
+
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions", "product", "sku"])
|
|
103
103
|
return false unless exported_object_validator.valid?(@exported_object)
|
|
104
104
|
true
|
|
105
105
|
end
|
|
@@ -17,10 +17,10 @@ module VoucherifySdk
|
|
|
17
17
|
class ExportsCreateRequestBodyParameters
|
|
18
18
|
attr_accessor :order
|
|
19
19
|
|
|
20
|
-
# Array of strings containing the data in the export. These fields define the headers in the CSV file.
|
|
20
|
+
# 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>`.
|
|
21
21
|
attr_accessor :fields
|
|
22
22
|
|
|
23
|
-
# 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.\"
|
|
23
|
+
# 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.\"
|
|
24
24
|
attr_accessor :filters
|
|
25
25
|
|
|
26
26
|
# Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered.
|
|
@@ -122,7 +122,7 @@ module VoucherifySdk
|
|
|
122
122
|
# @return true if the model is valid
|
|
123
123
|
def valid?
|
|
124
124
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
125
|
-
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at"])
|
|
125
|
+
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at", "-product_id", "product_id", "-sku", "sku"])
|
|
126
126
|
return false unless order_validator.valid?(@order)
|
|
127
127
|
true
|
|
128
128
|
end
|
|
@@ -177,7 +177,7 @@ module VoucherifySdk
|
|
|
177
177
|
return false unless object_validator.valid?(@object)
|
|
178
178
|
status_validator = EnumAttributeValidator.new('String', ["SCHEDULED"])
|
|
179
179
|
return false unless status_validator.valid?(@status)
|
|
180
|
-
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions"])
|
|
180
|
+
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions", "product", "sku"])
|
|
181
181
|
return false unless exported_object_validator.valid?(@exported_object)
|
|
182
182
|
true
|
|
183
183
|
end
|
|
@@ -17,10 +17,10 @@ module VoucherifySdk
|
|
|
17
17
|
class ExportsCreateResponseBodyParameters
|
|
18
18
|
attr_accessor :order
|
|
19
19
|
|
|
20
|
-
# Array of strings containing the data in the export. These fields define the headers in the CSV file.
|
|
20
|
+
# 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>`.
|
|
21
21
|
attr_accessor :fields
|
|
22
22
|
|
|
23
|
-
# 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.\"
|
|
23
|
+
# 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.\"
|
|
24
24
|
attr_accessor :filters
|
|
25
25
|
|
|
26
26
|
# Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered.
|
|
@@ -122,7 +122,7 @@ module VoucherifySdk
|
|
|
122
122
|
# @return true if the model is valid
|
|
123
123
|
def valid?
|
|
124
124
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
125
|
-
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at"])
|
|
125
|
+
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at", "-product_id", "product_id", "-sku", "sku"])
|
|
126
126
|
return false unless order_validator.valid?(@order)
|
|
127
127
|
true
|
|
128
128
|
end
|
|
@@ -174,7 +174,7 @@ module VoucherifySdk
|
|
|
174
174
|
return false unless object_validator.valid?(@object)
|
|
175
175
|
status_validator = EnumAttributeValidator.new('String', ["SCHEDULED", "IN_PROGRESS", "DONE", "ERROR"])
|
|
176
176
|
return false unless status_validator.valid?(@status)
|
|
177
|
-
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions"])
|
|
177
|
+
exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions", "product", "sku"])
|
|
178
178
|
return false unless exported_object_validator.valid?(@exported_object)
|
|
179
179
|
true
|
|
180
180
|
end
|
|
@@ -17,10 +17,10 @@ module VoucherifySdk
|
|
|
17
17
|
class ExportsGetResponseBodyParameters
|
|
18
18
|
attr_accessor :order
|
|
19
19
|
|
|
20
|
-
# Array of strings containing the data in the export. These fields define the headers in the CSV file.
|
|
20
|
+
# 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>`.
|
|
21
21
|
attr_accessor :fields
|
|
22
22
|
|
|
23
|
-
# 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.\"
|
|
23
|
+
# 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.\"
|
|
24
24
|
attr_accessor :filters
|
|
25
25
|
|
|
26
26
|
# Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered.
|
|
@@ -122,7 +122,7 @@ module VoucherifySdk
|
|
|
122
122
|
# @return true if the model is valid
|
|
123
123
|
def valid?
|
|
124
124
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
125
|
-
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at"])
|
|
125
|
+
order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at", "-updated_at", "updated_at", "-code", "code", "-id", "id", "-voucher_code", "voucher_code", "-tracking_id", "tracking_id", "-customer_id", "customer_id", "-name", "name", "-email", "email", "-source_id", "source_id", "-channel", "channel", "-status", "status", "-expires_at", "expires_at", "-product_id", "product_id", "-sku", "sku"])
|
|
126
126
|
return false unless order_validator.valid?(@order)
|
|
127
127
|
true
|
|
128
128
|
end
|