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.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +55 -55
  4. data/Gemfile.lock +2 -2
  5. data/README.md +5 -0
  6. data/docs/CampaignsApi.md +7 -7
  7. data/docs/ClientSideApi.md +2 -2
  8. data/docs/CustomersApi.md +5 -5
  9. data/docs/ErrorError.md +1 -1
  10. data/docs/ExportParameters.md +2 -2
  11. data/docs/ExportsApi.md +6 -6
  12. data/docs/ExportsCreateRequestBodyParameters.md +2 -2
  13. data/docs/ExportsCreateResponseBodyParameters.md +2 -2
  14. data/docs/ExportsGetResponseBodyParameters.md +2 -2
  15. data/docs/LoyaltiesApi.md +52 -52
  16. data/docs/ManagementApi.md +26 -26
  17. data/docs/MetadataSchemasApi.md +2 -2
  18. data/docs/OrdersApi.md +2 -2
  19. data/docs/ProductCollectionsApi.md +1 -1
  20. data/docs/ProductsApi.md +4 -4
  21. data/docs/PublicationsApi.md +3 -3
  22. data/docs/QualificationsApi.md +1 -1
  23. data/docs/RedemptionRewardResultParametersCoin.md +1 -1
  24. data/docs/RedemptionsApi.md +3 -3
  25. data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -0
  26. data/docs/ReferralsApi.md +4 -4
  27. data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
  28. data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
  29. data/docs/SegmentsApi.md +1 -1
  30. data/docs/TemplatesApi.md +7 -7
  31. data/docs/ValidationRulesApi.md +2 -2
  32. data/docs/ValidationsValidateRequestBodyOptions.md +1 -0
  33. data/docs/VouchersApi.md +8 -8
  34. data/lib/VoucherifySdk/api/campaigns_api.rb +14 -14
  35. data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
  36. data/lib/VoucherifySdk/api/customers_api.rb +10 -10
  37. data/lib/VoucherifySdk/api/exports_api.rb +8 -8
  38. data/lib/VoucherifySdk/api/loyalties_api.rb +104 -104
  39. data/lib/VoucherifySdk/api/management_api.rb +52 -52
  40. data/lib/VoucherifySdk/api/metadata_schemas_api.rb +4 -4
  41. data/lib/VoucherifySdk/api/orders_api.rb +4 -4
  42. data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
  43. data/lib/VoucherifySdk/api/products_api.rb +8 -8
  44. data/lib/VoucherifySdk/api/publications_api.rb +6 -6
  45. data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
  46. data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
  47. data/lib/VoucherifySdk/api/referrals_api.rb +8 -8
  48. data/lib/VoucherifySdk/api/segments_api.rb +2 -2
  49. data/lib/VoucherifySdk/api/templates_api.rb +14 -14
  50. data/lib/VoucherifySdk/api/validation_rules_api.rb +4 -4
  51. data/lib/VoucherifySdk/api/vouchers_api.rb +16 -16
  52. data/lib/VoucherifySdk/models/error_error.rb +2 -2
  53. data/lib/VoucherifySdk/models/export.rb +1 -1
  54. data/lib/VoucherifySdk/models/export_parameters.rb +3 -3
  55. data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
  56. data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +3 -3
  57. data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
  58. data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +3 -3
  59. data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -1
  60. data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +3 -3
  61. data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
  62. data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +28 -6
  63. data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
  64. data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
  65. data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
  66. data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +28 -6
  67. data/lib/VoucherifySdk/version.rb +1 -1
  68. metadata +32 -32
data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb CHANGED
@@ -14,11 +14,14 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module VoucherifySdk
17
- # Configure parameters returned in the response.
17
+ # Configure response expansion and the language of custom validation-rule error messages.
18
18
  class RedemptionsRedeemRequestBodyOptions
19
19
  # Expand array lets you configure params included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br />- Order data with calculated discounts are listed in each child redeemable object.<br />- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br />- Includes `metadata` for each discount type. | | [\"redeemable\", \"redemption\", \"category\"] | - Returns each discount type's `metadata` in each child redemption object.<br />- Returns redemption object `metadata`.<br />- Returns an expanded `categories` object, showing details about the category. |
20
20
  attr_accessor :expand
21
21
 
22
+ # Selects the language for the custom validation-rule error message. Returns the message in this language when a validation rule fails. Falls back to the Error Message Library default language when omitted or when the requested language has no message. Omits the custom error when no message can be resolved.
23
+ attr_accessor :language
24
+
22
25
  class EnumAttributeValidator
23
26
  attr_reader :datatype
24
27
  attr_reader :allowable_values
@@ -44,7 +47,8 @@ module VoucherifySdk
44
47
  # Attribute mapping from ruby-style variable name to JSON key.
45
48
  def self.attribute_map
46
49
  {
47
- :'expand' => :'expand'
50
+ :'expand' => :'expand',
51
+ :'language' => :'language'
48
52
  }
49
53
  end
50
54
 
@@ -56,14 +60,16 @@ module VoucherifySdk
56
60
  # Attribute type mapping.
57
61
  def self.openapi_types
58
62
  {
59
- :'expand' => :'Array<String>'
63
+ :'expand' => :'Array<String>',
64
+ :'language' => :'String'
60
65
  }
61
66
  end
62
67
 
63
68
  # List of attributes with nullable: true
64
69
  def self.openapi_nullable
65
70
  Set.new([
66
- :'expand'
71
+ :'expand',
72
+ :'language'
67
73
  ])
68
74
  end
69
75
 
@@ -80,6 +86,10 @@ module VoucherifySdk
80
86
  self.expand = value
81
87
  end
82
88
  end
89
+
90
+ if attributes.key?(:'language')
91
+ self.language = attributes[:'language']
92
+ end
83
93
  end
84
94
 
85
95
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -87,6 +97,15 @@ module VoucherifySdk
87
97
  def list_invalid_properties
88
98
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
89
99
  invalid_properties = Array.new
100
+ if !@language.nil? && @language.to_s.length > 100
101
+ invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 100.')
102
+ end
103
+
104
+ pattern = Regexp.new(/^[a-zA-Z]{2,3}(-[a-zA-Z]{2,4})?$/)
105
+ if !@language.nil? && @language !~ pattern
106
+ invalid_properties.push("invalid value for \"language\", must conform to the pattern #{pattern}.")
107
+ end
108
+
90
109
  invalid_properties
91
110
  end
92
111
 
@@ -94,6 +113,8 @@ module VoucherifySdk
94
113
  # @return true if the model is valid
95
114
  def valid?
96
115
  warn '[DEPRECATED] the `valid?` method is obsolete'
116
+ return false if !@language.nil? && @language.to_s.length > 100
117
+ return false if !@language.nil? && @language !~ Regexp.new(/^[a-zA-Z]{2,3}(-[a-zA-Z]{2,4})?$/)
97
118
  true
98
119
  end
99
120
 
@@ -102,7 +123,8 @@ module VoucherifySdk
102
123
  def ==(o)
103
124
  return true if self.equal?(o)
104
125
  self.class == o.class &&
105
- expand == o.expand
126
+ expand == o.expand &&
127
+ language == o.language
106
128
  end
107
129
 
108
130
  # @see the `==` method
@@ -114,7 +136,7 @@ module VoucherifySdk
114
136
  # Calculates hash code according to all attributes.
115
137
  # @return [Integer] Hash code
116
138
  def hash
117
- [expand].hash
139
+ [expand, language].hash
118
140
  end
119
141
 
120
142
  # Builds the object from hash
data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb CHANGED
@@ -38,7 +38,7 @@ module VoucherifySdk
38
38
  # Attribute type mapping.
39
39
  def self.openapi_types
40
40
  {
41
- :'exchange_ratio' => :'String',
41
+ :'exchange_ratio' => :'Float',
42
42
  :'points_ratio' => :'String'
43
43
  }
44
44
  end
data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb CHANGED
@@ -38,7 +38,7 @@ module VoucherifySdk
38
38
  # Attribute type mapping.
39
39
  def self.openapi_types
40
40
  {
41
- :'exchange_ratio' => :'String',
41
+ :'exchange_ratio' => :'Float',
42
42
  :'points_ratio' => :'String'
43
43
  }
44
44
  end
data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb CHANGED
@@ -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
- key_validator = EnumAttributeValidator.new('String', ["applicable_redeemables_limit_exceeded", "applicable_redeemables_per_category_limit_exceeded", "applicable_exclusive_redeemables_limit_exceeded", "applicable_exclusive_redeemables_per_category_limit_exceeded", "exclusion_rules_not_met", "preceding_validation_failed"])
102
+ key_validator = EnumAttributeValidator.new('String', ["applicable_redeemables_limit_exceeded", "applicable_redeemables_per_category_limit_exceeded", "applicable_exclusive_redeemables_limit_exceeded", "applicable_exclusive_redeemables_per_category_limit_exceeded", "exclusion_rules_not_met", "preceding_validation_failed", "no_effect"])
103
103
  return false unless key_validator.valid?(@key)
104
104
  true
105
105
  end
data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb CHANGED
@@ -14,11 +14,14 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module VoucherifySdk
17
- # Configure parameters returned in the response.
17
+ # Configure response expansion and the language of custom validation-rule error messages.
18
18
  class ValidationsValidateRequestBodyOptions
19
19
  # The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br />- Order data with calculated discounts are listed in each child redeemable object.<br />- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br />- Includes `metadata` for each discount type. | | [\"category\"] | - Returns an expanded `categories` object, showing details about the category. |
20
20
  attr_accessor :expand
21
21
 
22
+ # Selects the language for the custom validation-rule error message. Returns the message in this language when a validation rule fails. Falls back to the Error Message Library default language when omitted or when the requested language has no message. Omits the custom error when no message can be resolved.
23
+ attr_accessor :language
24
+
22
25
  class EnumAttributeValidator
23
26
  attr_reader :datatype
24
27
  attr_reader :allowable_values
@@ -44,7 +47,8 @@ module VoucherifySdk
44
47
  # Attribute mapping from ruby-style variable name to JSON key.
45
48
  def self.attribute_map
46
49
  {
47
- :'expand' => :'expand'
50
+ :'expand' => :'expand',
51
+ :'language' => :'language'
48
52
  }
49
53
  end
50
54
 
@@ -56,14 +60,16 @@ module VoucherifySdk
56
60
  # Attribute type mapping.
57
61
  def self.openapi_types
58
62
  {
59
- :'expand' => :'Array<String>'
63
+ :'expand' => :'Array<String>',
64
+ :'language' => :'String'
60
65
  }
61
66
  end
62
67
 
63
68
  # List of attributes with nullable: true
64
69
  def self.openapi_nullable
65
70
  Set.new([
66
- :'expand'
71
+ :'expand',
72
+ :'language'
67
73
  ])
68
74
  end
69
75
 
@@ -80,6 +86,10 @@ module VoucherifySdk
80
86
  self.expand = value
81
87
  end
82
88
  end
89
+
90
+ if attributes.key?(:'language')
91
+ self.language = attributes[:'language']
92
+ end
83
93
  end
84
94
 
85
95
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -87,6 +97,15 @@ module VoucherifySdk
87
97
  def list_invalid_properties
88
98
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
89
99
  invalid_properties = Array.new
100
+ if !@language.nil? && @language.to_s.length > 100
101
+ invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 100.')
102
+ end
103
+
104
+ pattern = Regexp.new(/^[a-zA-Z]{2,3}(-[a-zA-Z]{2,4})?$/)
105
+ if !@language.nil? && @language !~ pattern
106
+ invalid_properties.push("invalid value for \"language\", must conform to the pattern #{pattern}.")
107
+ end
108
+
90
109
  invalid_properties
91
110
  end
92
111
 
@@ -94,6 +113,8 @@ module VoucherifySdk
94
113
  # @return true if the model is valid
95
114
  def valid?
96
115
  warn '[DEPRECATED] the `valid?` method is obsolete'
116
+ return false if !@language.nil? && @language.to_s.length > 100
117
+ return false if !@language.nil? && @language !~ Regexp.new(/^[a-zA-Z]{2,3}(-[a-zA-Z]{2,4})?$/)
97
118
  true
98
119
  end
99
120
 
@@ -102,7 +123,8 @@ module VoucherifySdk
102
123
  def ==(o)
103
124
  return true if self.equal?(o)
104
125
  self.class == o.class &&
105
- expand == o.expand
126
+ expand == o.expand &&
127
+ language == o.language
106
128
  end
107
129
 
108
130
  # @see the `==` method
@@ -114,7 +136,7 @@ module VoucherifySdk
114
136
  # Calculates hash code according to all attributes.
115
137
  # @return [Integer] Hash code
116
138
  def hash
117
- [expand].hash
139
+ [expand, language].hash
118
140
  end
119
141
 
120
142
  # Builds the object from hash
data/lib/VoucherifySdk/version.rb CHANGED
@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.0.1
11
11
  =end
12
12
 
13
13
  module VoucherifySdk
14
- VERSION = '8.1.0'
14
+ VERSION = '8.1.1'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voucherify
3
3
  version: !ruby/object:Gem::Version
4
- version: 8.1.0
4
+ version: 8.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - pawelrychlik
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-08-06 00:00:00.000000000 Z
11
+ date: 2026-10-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -2664,44 +2664,44 @@ test_files:
2664
2664
  - __tests__/spec/12_validation_rules_spec.rb
2665
2665
  - __tests__/spec/13_management_spec.rb
2666
2666
  - __tests__/spec/14_additional_properties_spec.rb
2667
- - __tests__/spec/snapshots/campaigns/created_validation_rule_applicable_to.snap
2668
- - __tests__/spec/snapshots/campaigns/added_voucher_to_campaign.snap
2669
- - __tests__/spec/snapshots/campaigns/added_loyalty_card_to_campaign.snap
2670
- - __tests__/spec/snapshots/campaigns/created_discount_campaign.snap
2671
- - __tests__/spec/snapshots/campaigns/created_validation_rule_more_than.snap
2672
- - __tests__/spec/snapshots/campaigns/created_loyalty_campaign.snap
2673
- - __tests__/spec/snapshots/campaigns/created_promotion_campaign.snap
2674
- - __tests__/spec/snapshots/campaigns/created_discount_campaign_with_val_rule.snap
2675
- - __tests__/spec/snapshots/validation_rules/created_validation_rule_assignment.snap
2676
2667
  - __tests__/spec/snapshots/publications/created_publication.snap
2677
- - __tests__/spec/snapshots/loyalties/member_transactions.snap
2668
+ - __tests__/spec/snapshots/validations_rules/created_validation_rule_assignment.snap
2669
+ - __tests__/spec/snapshots/events/created_event.snap
2678
2670
  - __tests__/spec/snapshots/loyalties/updated_loyalty_member_card.snap
2679
- - __tests__/spec/snapshots/vouchers/disabled_previously_created_voucher.snap
2671
+ - __tests__/spec/snapshots/loyalties/member_transactions.snap
2672
+ - __tests__/spec/snapshots/qualifications/checked_eligibility.snap
2680
2673
  - __tests__/spec/snapshots/vouchers/enabled_previously_created_voucher.snap
2681
- - __tests__/spec/snapshots/vouchers/get_previously_created_voucher.snap
2682
2674
  - __tests__/spec/snapshots/vouchers/updated_loyalty_card_balance.snap
2683
- - __tests__/spec/snapshots/customers/deleted_customer.snap
2684
- - __tests__/spec/snapshots/customers/created_customer.snap
2685
- - __tests__/spec/snapshots/orders/created_order.snap
2686
- - __tests__/spec/snapshots/orders/updated_created_order_to_paid_status.snap
2687
- - __tests__/spec/snapshots/orders/list_orders.snap
2688
- - __tests__/spec/snapshots/validations/validations_succesful_order.snap
2689
- - __tests__/spec/snapshots/validations/inapplicable_stacked_validation.snap
2690
- - __tests__/spec/snapshots/validations/redeemable_items_necessary_keys.snap
2691
- - __tests__/spec/snapshots/validations/applicable_stacked_validation.snap
2675
+ - __tests__/spec/snapshots/vouchers/get_previously_created_voucher.snap
2676
+ - __tests__/spec/snapshots/vouchers/disabled_previously_created_voucher.snap
2677
+ - __tests__/spec/snapshots/validation_rules/created_validation_rule_assignment.snap
2692
2678
  - __tests__/spec/snapshots/redemptions/redeem_stacked_applicable_discounts.snap
2693
2679
  - __tests__/spec/snapshots/redemptions/redeem_stacked_skipped_discounts.snap
2694
- - __tests__/spec/snapshots/validations_rules/created_validation_rule_assignment.snap
2695
- - __tests__/spec/snapshots/qualifications/checked_eligibility.snap
2696
- - __tests__/spec/snapshots/products/updated_product_sku.snap
2680
+ - __tests__/spec/snapshots/customers/created_customer.snap
2681
+ - __tests__/spec/snapshots/customers/deleted_customer.snap
2682
+ - __tests__/spec/snapshots/products/created_product2.snap
2683
+ - __tests__/spec/snapshots/products/list_skus.snap
2697
2684
  - __tests__/spec/snapshots/products/get_previously_created_product.snap
2685
+ - __tests__/spec/snapshots/products/created_product.snap
2698
2686
  - __tests__/spec/snapshots/products/added_sku_to_product.snap
2699
2687
  - __tests__/spec/snapshots/products/updated_product_price.snap
2700
- - __tests__/spec/snapshots/products/created_product2.snap
2701
- - __tests__/spec/snapshots/products/list_skus.snap
2688
+ - __tests__/spec/snapshots/products/updated_product_sku.snap
2702
2689
  - __tests__/spec/snapshots/products/get_product_sku.snap
2703
- - __tests__/spec/snapshots/products/created_product.snap
2704
- - __tests__/spec/snapshots/events/created_event.snap
2705
- - __tests__/spec/support/snapshot_helper.rb
2706
- - __tests__/spec/support/get_snapshot_without_uniq_keys.rb
2690
+ - __tests__/spec/snapshots/validations/validations_succesful_order.snap
2691
+ - __tests__/spec/snapshots/validations/applicable_stacked_validation.snap
2692
+ - __tests__/spec/snapshots/validations/redeemable_items_necessary_keys.snap
2693
+ - __tests__/spec/snapshots/validations/inapplicable_stacked_validation.snap
2694
+ - __tests__/spec/snapshots/orders/created_order.snap
2695
+ - __tests__/spec/snapshots/orders/updated_created_order_to_paid_status.snap
2696
+ - __tests__/spec/snapshots/orders/list_orders.snap
2697
+ - __tests__/spec/snapshots/campaigns/added_loyalty_card_to_campaign.snap
2698
+ - __tests__/spec/snapshots/campaigns/created_loyalty_campaign.snap
2699
+ - __tests__/spec/snapshots/campaigns/created_validation_rule_more_than.snap
2700
+ - __tests__/spec/snapshots/campaigns/created_promotion_campaign.snap
2701
+ - __tests__/spec/snapshots/campaigns/added_voucher_to_campaign.snap
2702
+ - __tests__/spec/snapshots/campaigns/created_validation_rule_applicable_to.snap
2703
+ - __tests__/spec/snapshots/campaigns/created_discount_campaign_with_val_rule.snap
2704
+ - __tests__/spec/snapshots/campaigns/created_discount_campaign.snap
2707
2705
  - __tests__/spec/support/validate_deep_match.rb
2706
+ - __tests__/spec/support/get_snapshot_without_uniq_keys.rb
2707
+ - __tests__/spec/support/snapshot_helper.rb