voucherify 8.0.1 → 8.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +64 -60
  4. data/Gemfile.lock +4 -4
  5. data/README.md +11 -0
  6. data/docs/Campaign.md +2 -2
  7. data/docs/CampaignBase.md +2 -2
  8. data/docs/CampaignsApi.md +3 -3
  9. data/docs/CampaignsCreateRequestBody.md +1 -1
  10. data/docs/CampaignsCreateResponseBody.md +2 -2
  11. data/docs/CampaignsGetResponseBody.md +2 -2
  12. data/docs/CampaignsUpdateRequestBody.md +2 -2
  13. data/docs/CampaignsUpdateResponseBody.md +2 -2
  14. data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md +3 -2
  15. data/docs/Error.md +1 -0
  16. data/docs/ErrorError.md +8 -0
  17. data/docs/LoyaltiesCreateCampaignRequestBody.md +1 -1
  18. data/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +1 -1
  19. data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +9 -9
  20. data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md +1 -1
  21. data/docs/LoyaltiesUpdateCampaignRequestBody.md +2 -2
  22. data/docs/LoyaltyCardTransaction.md +2 -2
  23. data/docs/LoyaltyCardTransactionDetailsBalance.md +5 -4
  24. data/docs/LoyaltyCardTransactionDetailsBalanceRelatedObject.md +1 -1
  25. data/docs/LoyaltyPointsBucket.md +16 -0
  26. data/docs/LoyaltyPointsBucketBucket.md +8 -0
  27. data/docs/Order.md +1 -1
  28. data/docs/OrderCalculated.md +1 -1
  29. data/docs/OrderCalculatedItem.md +1 -1
  30. data/docs/OrderCalculatedItemProduct.md +1 -1
  31. data/docs/OrderCalculatedItemSku.md +1 -0
  32. data/docs/OrderItem.md +1 -1
  33. data/docs/OrderItemProduct.md +1 -1
  34. data/docs/OrderItemSku.md +1 -0
  35. data/docs/OrdersCreateRequestBody.md +1 -1
  36. data/docs/OrdersCreateResponseBody.md +1 -1
  37. data/docs/OrdersGetResponseBody.md +1 -1
  38. data/docs/OrdersImportCreateRequestBodyItem.md +1 -1
  39. data/docs/OrdersUpdateRequestBody.md +1 -1
  40. data/docs/OrdersUpdateResponseBody.md +1 -1
  41. data/docs/Product.md +1 -1
  42. data/docs/ProductCollectionsProductsListResponseBodyDataItem.md +1 -1
  43. data/docs/ProductWithoutSkus.md +1 -1
  44. data/docs/ProductsCreateResponseBody.md +1 -1
  45. data/docs/ProductsGetResponseBody.md +1 -1
  46. data/docs/ProductsSkusCreateResponseBody.md +1 -1
  47. data/docs/ProductsSkusUpdateResponseBody.md +1 -1
  48. data/docs/ProductsUpdateResponseBody.md +1 -1
  49. data/docs/RedemptionEntryOrder.md +1 -1
  50. data/docs/RedemptionsGetResponseBodyOrder.md +1 -1
  51. data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +1 -1
  52. data/docs/Sku.md +1 -1
  53. data/docs/SkusGetResponseBody.md +1 -1
  54. data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +1 -1
  55. data/docs/ValidationsRedeemableInapplicable.md +3 -2
  56. data/docs/ValidationsRedeemableSkipped.md +3 -2
  57. data/docs/ValidationsValidateResponseBodyRedeemablesItem.md +3 -2
  58. data/docs/VoucherBalance.md +14 -0
  59. data/docs/VoucherBalanceRelatedObject.md +9 -0
  60. data/docs/VoucherTransaction.md +2 -2
  61. data/docs/VoucherTransactionDetailsBalance.md +5 -4
  62. data/docs/VoucherTransactionDetailsBalanceRelatedObject.md +1 -1
  63. data/docs/VouchersApi.md +6 -6
  64. data/docs/VouchersBalanceUpdateResponseBody.md +1 -1
  65. data/lib/VoucherifySdk/api/campaigns_api.rb +4 -4
  66. data/lib/VoucherifySdk/api/vouchers_api.rb +10 -10
  67. data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
  68. data/lib/VoucherifySdk/models/campaign.rb +3 -3
  69. data/lib/VoucherifySdk/models/campaign_base.rb +3 -3
  70. data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +1 -1
  71. data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +3 -3
  72. data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +3 -3
  73. data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +2 -2
  74. data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +3 -3
  75. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item.rb +18 -7
  76. data/lib/VoucherifySdk/models/error.rb +15 -5
  77. data/lib/VoucherifySdk/models/error_error.rb +210 -0
  78. data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +1 -1
  79. data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body.rb +1 -0
  80. data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +27 -77
  81. data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb +3 -9
  82. data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +2 -2
  83. data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +24 -31
  84. data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +0 -1
  85. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +18 -19
  86. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance_related_object.rb +1 -7
  87. data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +323 -0
  88. data/lib/VoucherifySdk/models/loyalty_points_bucket_bucket.rb +210 -0
  89. data/lib/VoucherifySdk/models/order.rb +1 -1
  90. data/lib/VoucherifySdk/models/order_calculated.rb +1 -1
  91. data/lib/VoucherifySdk/models/order_calculated_item.rb +1 -1
  92. data/lib/VoucherifySdk/models/order_calculated_item_product.rb +1 -1
  93. data/lib/VoucherifySdk/models/order_calculated_item_sku.rb +16 -5
  94. data/lib/VoucherifySdk/models/order_item.rb +1 -1
  95. data/lib/VoucherifySdk/models/order_item_product.rb +1 -1
  96. data/lib/VoucherifySdk/models/order_item_sku.rb +16 -5
  97. data/lib/VoucherifySdk/models/orders_create_request_body.rb +1 -1
  98. data/lib/VoucherifySdk/models/orders_create_response_body.rb +1 -1
  99. data/lib/VoucherifySdk/models/orders_get_response_body.rb +1 -1
  100. data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +1 -1
  101. data/lib/VoucherifySdk/models/orders_update_request_body.rb +1 -1
  102. data/lib/VoucherifySdk/models/orders_update_response_body.rb +1 -1
  103. data/lib/VoucherifySdk/models/parameter_expand_list_campaigns.rb +2 -1
  104. data/lib/VoucherifySdk/models/product.rb +1 -1
  105. data/lib/VoucherifySdk/models/product_collections_products_list_response_body_data_item.rb +1 -1
  106. data/lib/VoucherifySdk/models/product_without_skus.rb +1 -1
  107. data/lib/VoucherifySdk/models/products_create_response_body.rb +1 -1
  108. data/lib/VoucherifySdk/models/products_get_response_body.rb +1 -1
  109. data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
  110. data/lib/VoucherifySdk/models/products_skus_update_response_body.rb +1 -1
  111. data/lib/VoucherifySdk/models/products_update_response_body.rb +1 -1
  112. data/lib/VoucherifySdk/models/redemption_entry_order.rb +1 -1
  113. data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +1 -1
  114. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +1 -1
  115. data/lib/VoucherifySdk/models/sku.rb +1 -1
  116. data/lib/VoucherifySdk/models/skus_get_response_body.rb +1 -1
  117. data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +1 -1
  118. data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +18 -7
  119. data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +18 -7
  120. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item.rb +18 -7
  121. data/lib/VoucherifySdk/models/voucher_balance.rb +305 -0
  122. data/lib/VoucherifySdk/models/voucher_balance_related_object.rb +247 -0
  123. data/lib/VoucherifySdk/models/voucher_transaction.rb +27 -31
  124. data/lib/VoucherifySdk/models/voucher_transaction_details.rb +0 -1
  125. data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +18 -19
  126. data/lib/VoucherifySdk/models/voucher_transaction_details_balance_related_object.rb +1 -7
  127. data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +1 -0
  128. data/lib/VoucherifySdk/version.rb +1 -1
  129. data/lib/VoucherifySdk.rb +5 -0
  130. metadata +12 -2
@@ -73,7 +73,7 @@ module VoucherifySdk
73
73
  # The type of the object represented by JSON.
74
74
  attr_accessor :object
75
75
 
76
- # A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format.
76
+ # A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.
77
77
  attr_accessor :metadata
78
78
 
79
79
  class EnumAttributeValidator
@@ -28,7 +28,7 @@ module VoucherifySdk
28
28
  # Product name.
29
29
  attr_accessor :name
30
30
 
31
- # A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format.
31
+ # A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
32
32
  attr_accessor :metadata
33
33
 
34
34
  # Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
@@ -31,6 +31,9 @@ module VoucherifySdk
31
31
  # SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
32
32
  attr_accessor :price
33
33
 
34
+ # A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
35
+ attr_accessor :metadata
36
+
34
37
  # Attribute mapping from ruby-style variable name to JSON key.
35
38
  def self.attribute_map
36
39
  {
@@ -38,7 +41,8 @@ module VoucherifySdk
38
41
  :'source_id' => :'source_id',
39
42
  :'override' => :'override',
40
43
  :'sku' => :'sku',
41
- :'price' => :'price'
44
+ :'price' => :'price',
45
+ :'metadata' => :'metadata'
42
46
  }
43
47
  end
44
48
 
@@ -54,7 +58,8 @@ module VoucherifySdk
54
58
  :'source_id' => :'String',
55
59
  :'override' => :'Boolean',
56
60
  :'sku' => :'String',
57
- :'price' => :'Float'
61
+ :'price' => :'Float',
62
+ :'metadata' => :'Object'
58
63
  }
59
64
  end
60
65
 
@@ -65,7 +70,8 @@ module VoucherifySdk
65
70
  :'source_id',
66
71
  :'override',
67
72
  :'sku',
68
- :'price'
73
+ :'price',
74
+ :'metadata'
69
75
  ])
70
76
  end
71
77
 
@@ -96,6 +102,10 @@ module VoucherifySdk
96
102
  if attributes.key?(:'price')
97
103
  self.price = attributes[:'price']
98
104
  end
105
+
106
+ if attributes.key?(:'metadata')
107
+ self.metadata = attributes[:'metadata']
108
+ end
99
109
  end
100
110
 
101
111
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +132,8 @@ module VoucherifySdk
122
132
  source_id == o.source_id &&
123
133
  override == o.override &&
124
134
  sku == o.sku &&
125
- price == o.price
135
+ price == o.price &&
136
+ metadata == o.metadata
126
137
  end
127
138
 
128
139
  # @see the `==` method
@@ -134,7 +145,7 @@ module VoucherifySdk
134
145
  # Calculates hash code according to all attributes.
135
146
  # @return [Integer] Hash code
136
147
  def hash
137
- [id, source_id, override, sku, price].hash
148
+ [id, source_id, override, sku, price, metadata].hash
138
149
  end
139
150
 
140
151
  # Builds the object from hash
@@ -52,7 +52,7 @@ module VoucherifySdk
52
52
 
53
53
  attr_accessor :sku
54
54
 
55
- # A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format.
55
+ # A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to define business validation rules.
56
56
  attr_accessor :metadata
57
57
 
58
58
  class EnumAttributeValidator
@@ -28,7 +28,7 @@ module VoucherifySdk
28
28
  # Product name.
29
29
  attr_accessor :name
30
30
 
31
- # A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format.
31
+ # A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
32
32
  attr_accessor :metadata
33
33
 
34
34
  # Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
@@ -31,6 +31,9 @@ module VoucherifySdk
31
31
  # SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
32
32
  attr_accessor :price
33
33
 
34
+ # A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to create product collections.
35
+ attr_accessor :metadata
36
+
34
37
  # Attribute mapping from ruby-style variable name to JSON key.
35
38
  def self.attribute_map
36
39
  {
@@ -38,7 +41,8 @@ module VoucherifySdk
38
41
  :'source_id' => :'source_id',
39
42
  :'override' => :'override',
40
43
  :'sku' => :'sku',
41
- :'price' => :'price'
44
+ :'price' => :'price',
45
+ :'metadata' => :'metadata'
42
46
  }
43
47
  end
44
48
 
@@ -54,7 +58,8 @@ module VoucherifySdk
54
58
  :'source_id' => :'String',
55
59
  :'override' => :'Boolean',
56
60
  :'sku' => :'String',
57
- :'price' => :'Float'
61
+ :'price' => :'Float',
62
+ :'metadata' => :'Object'
58
63
  }
59
64
  end
60
65
 
@@ -65,7 +70,8 @@ module VoucherifySdk
65
70
  :'source_id',
66
71
  :'override',
67
72
  :'sku',
68
- :'price'
73
+ :'price',
74
+ :'metadata'
69
75
  ])
70
76
  end
71
77
 
@@ -96,6 +102,10 @@ module VoucherifySdk
96
102
  if attributes.key?(:'price')
97
103
  self.price = attributes[:'price']
98
104
  end
105
+
106
+ if attributes.key?(:'metadata')
107
+ self.metadata = attributes[:'metadata']
108
+ end
99
109
  end
100
110
 
101
111
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +132,8 @@ module VoucherifySdk
122
132
  source_id == o.source_id &&
123
133
  override == o.override &&
124
134
  sku == o.sku &&
125
- price == o.price
135
+ price == o.price &&
136
+ metadata == o.metadata
126
137
  end
127
138
 
128
139
  # @see the `==` method
@@ -134,7 +145,7 @@ module VoucherifySdk
134
145
  # Calculates hash code according to all attributes.
135
146
  # @return [Integer] Hash code
136
147
  def hash
137
- [id, source_id, override, sku, price].hash
148
+ [id, source_id, override, sku, price, metadata].hash
138
149
  end
139
150
 
140
151
  # Builds the object from hash
@@ -37,7 +37,7 @@ module VoucherifySdk
37
37
  # Array of items applied to the order. It can include up 500 items.
38
38
  attr_accessor :items
39
39
 
40
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
40
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
41
41
  attr_accessor :metadata
42
42
 
43
43
  # Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
@@ -55,7 +55,7 @@ module VoucherifySdk
55
55
  # Array of items applied to the order. It can include up 500 items.
56
56
  attr_accessor :items
57
57
 
58
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
58
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
59
59
  attr_accessor :metadata
60
60
 
61
61
  # The type of the object represented by JSON.
@@ -55,7 +55,7 @@ module VoucherifySdk
55
55
  # Array of items applied to the order. It can include up 500 items.
56
56
  attr_accessor :items
57
57
 
58
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
58
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
59
59
  attr_accessor :metadata
60
60
 
61
61
  # The type of the object represented by JSON.
@@ -36,7 +36,7 @@ module VoucherifySdk
36
36
  # Array of items applied to the order. It can include up 500 items.
37
37
  attr_accessor :items
38
38
 
39
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
39
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
40
40
  attr_accessor :metadata
41
41
 
42
42
  # Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
@@ -34,7 +34,7 @@ module VoucherifySdk
34
34
  # Array of items applied to the order. It can include up 500 items.
35
35
  attr_accessor :items
36
36
 
37
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
37
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
38
38
  attr_accessor :metadata
39
39
 
40
40
  # Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
@@ -55,7 +55,7 @@ module VoucherifySdk
55
55
  # Array of items applied to the order. It can include up 500 items.
56
56
  attr_accessor :items
57
57
 
58
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
58
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
59
59
  attr_accessor :metadata
60
60
 
61
61
  # The type of the object represented by JSON.
@@ -16,9 +16,10 @@ require 'time'
16
16
  module VoucherifySdk
17
17
  class ParameterExpandListCampaigns
18
18
  CATEGORY = "category".freeze
19
+ ACCESS_SETTINGS_ASSIGNMENTS = "access_settings_assignments".freeze
19
20
 
20
21
  def self.all_vars
21
- @all_vars ||= [CATEGORY].freeze
22
+ @all_vars ||= [CATEGORY, ACCESS_SETTINGS_ASSIGNMENTS].freeze
22
23
  end
23
24
 
24
25
  # Builds the enum from string
@@ -31,7 +31,7 @@ module VoucherifySdk
31
31
  # A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute.
32
32
  attr_accessor :attributes
33
33
 
34
- # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
34
+ # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
35
35
  attr_accessor :metadata
36
36
 
37
37
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
@@ -28,7 +28,7 @@ module VoucherifySdk
28
28
  # A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute.
29
29
  attr_accessor :attributes
30
30
 
31
- # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. and The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
31
+ # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. and The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
32
32
  attr_accessor :metadata
33
33
 
34
34
  attr_accessor :image_url
@@ -30,7 +30,7 @@ module VoucherifySdk
30
30
  # A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute.
31
31
  attr_accessor :attributes
32
32
 
33
- # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
33
+ # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
34
34
  attr_accessor :metadata
35
35
 
36
36
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
@@ -31,7 +31,7 @@ module VoucherifySdk
31
31
  # A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute.
32
32
  attr_accessor :attributes
33
33
 
34
- # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
34
+ # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
35
35
  attr_accessor :metadata
36
36
 
37
37
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
@@ -31,7 +31,7 @@ module VoucherifySdk
31
31
  # A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute.
32
32
  attr_accessor :attributes
33
33
 
34
- # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
34
+ # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
35
35
  attr_accessor :metadata
36
36
 
37
37
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
@@ -40,7 +40,7 @@ module VoucherifySdk
40
40
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
41
41
  attr_accessor :image_url
42
42
 
43
- # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
43
+ # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
44
44
  attr_accessor :metadata
45
45
 
46
46
  # Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.
@@ -40,7 +40,7 @@ module VoucherifySdk
40
40
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
41
41
  attr_accessor :image_url
42
42
 
43
- # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
43
+ # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
44
44
  attr_accessor :metadata
45
45
 
46
46
  # Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.
@@ -31,7 +31,7 @@ module VoucherifySdk
31
31
  # A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute.
32
32
  attr_accessor :attributes
33
33
 
34
- # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
34
+ # The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
35
35
  attr_accessor :metadata
36
36
 
37
37
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
@@ -54,7 +54,7 @@ module VoucherifySdk
54
54
  # Array of items applied to the order. It can include up 500 items.
55
55
  attr_accessor :items
56
56
 
57
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
57
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
58
58
  attr_accessor :metadata
59
59
 
60
60
  # The type of the object represented by JSON.
@@ -54,7 +54,7 @@ module VoucherifySdk
54
54
  # Array of items applied to the order. It can include up 500 items.
55
55
  attr_accessor :items
56
56
 
57
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
57
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
58
58
  attr_accessor :metadata
59
59
 
60
60
  # The type of the object represented by JSON.
@@ -54,7 +54,7 @@ module VoucherifySdk
54
54
  # Array of items applied to the order. It can include up 500 items.
55
55
  attr_accessor :items
56
56
 
57
- # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
57
+ # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
58
58
  attr_accessor :metadata
59
59
 
60
60
  # The type of the object represented by JSON.
@@ -40,7 +40,7 @@ module VoucherifySdk
40
40
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
41
41
  attr_accessor :image_url
42
42
 
43
- # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
43
+ # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
44
44
  attr_accessor :metadata
45
45
 
46
46
  # Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.
@@ -40,7 +40,7 @@ module VoucherifySdk
40
40
  # The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
41
41
  attr_accessor :image_url
42
42
 
43
- # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
43
+ # The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
44
44
  attr_accessor :metadata
45
45
 
46
46
  # Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.
@@ -22,7 +22,7 @@ module VoucherifySdk
22
22
  # An optional field to keep any extra textual information about the campaign such as a campaign description and details.
23
23
  attr_accessor :description
24
24
 
25
- # Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published.
25
+ # Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published
26
26
  attr_accessor :type
27
27
 
28
28
  # If this value is set to `true`, customers will be able to join the campaign only once.
@@ -31,12 +31,15 @@ module VoucherifySdk
31
31
 
32
32
  attr_accessor :categories
33
33
 
34
- # Campaign name
34
+ # Campaign name. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
35
35
  attr_accessor :campaign_name
36
36
 
37
- # Unique campaign ID assigned by Voucherify.
37
+ # Unique campaign ID assigned by Voucherify. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
38
38
  attr_accessor :campaign_id
39
39
 
40
+ # Name of the promotion tier. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
41
+ attr_accessor :name
42
+
40
43
  class EnumAttributeValidator
41
44
  attr_reader :datatype
42
45
  attr_reader :allowable_values
@@ -69,7 +72,8 @@ module VoucherifySdk
69
72
  :'metadata' => :'metadata',
70
73
  :'categories' => :'categories',
71
74
  :'campaign_name' => :'campaign_name',
72
- :'campaign_id' => :'campaign_id'
75
+ :'campaign_id' => :'campaign_id',
76
+ :'name' => :'name'
73
77
  }
74
78
  end
75
79
 
@@ -88,7 +92,8 @@ module VoucherifySdk
88
92
  :'metadata' => :'Object',
89
93
  :'categories' => :'Array<CategoryWithStackingRulesType>',
90
94
  :'campaign_name' => :'String',
91
- :'campaign_id' => :'String'
95
+ :'campaign_id' => :'String',
96
+ :'name' => :'String'
92
97
  }
93
98
  end
94
99
 
@@ -102,7 +107,8 @@ module VoucherifySdk
102
107
  :'metadata',
103
108
  :'categories',
104
109
  :'campaign_name',
105
- :'campaign_id'
110
+ :'campaign_id',
111
+ :'name'
106
112
  ])
107
113
  end
108
114
 
@@ -149,6 +155,10 @@ module VoucherifySdk
149
155
  if attributes.key?(:'campaign_id')
150
156
  self.campaign_id = attributes[:'campaign_id']
151
157
  end
158
+
159
+ if attributes.key?(:'name')
160
+ self.name = attributes[:'name']
161
+ end
152
162
  end
153
163
 
154
164
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -182,7 +192,8 @@ module VoucherifySdk
182
192
  metadata == o.metadata &&
183
193
  categories == o.categories &&
184
194
  campaign_name == o.campaign_name &&
185
- campaign_id == o.campaign_id
195
+ campaign_id == o.campaign_id &&
196
+ name == o.name
186
197
  end
187
198
 
188
199
  # @see the `==` method
@@ -194,7 +205,7 @@ module VoucherifySdk
194
205
  # Calculates hash code according to all attributes.
195
206
  # @return [Integer] Hash code
196
207
  def hash
197
- [status, id, object, result, metadata, categories, campaign_name, campaign_id].hash
208
+ [status, id, object, result, metadata, categories, campaign_name, campaign_id, name].hash
198
209
  end
199
210
 
200
211
  # Builds the object from hash
@@ -31,12 +31,15 @@ module VoucherifySdk
31
31
 
32
32
  attr_accessor :categories
33
33
 
34
- # Campaign name
34
+ # Campaign name. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
35
35
  attr_accessor :campaign_name
36
36
 
37
- # Unique campaign ID assigned by Voucherify.
37
+ # Unique campaign ID assigned by Voucherify. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
38
38
  attr_accessor :campaign_id
39
39
 
40
+ # Name of the promotion tier. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
41
+ attr_accessor :name
42
+
40
43
  class EnumAttributeValidator
41
44
  attr_reader :datatype
42
45
  attr_reader :allowable_values
@@ -69,7 +72,8 @@ module VoucherifySdk
69
72
  :'metadata' => :'metadata',
70
73
  :'categories' => :'categories',
71
74
  :'campaign_name' => :'campaign_name',
72
- :'campaign_id' => :'campaign_id'
75
+ :'campaign_id' => :'campaign_id',
76
+ :'name' => :'name'
73
77
  }
74
78
  end
75
79
 
@@ -88,7 +92,8 @@ module VoucherifySdk
88
92
  :'metadata' => :'Object',
89
93
  :'categories' => :'Array<CategoryWithStackingRulesType>',
90
94
  :'campaign_name' => :'String',
91
- :'campaign_id' => :'String'
95
+ :'campaign_id' => :'String',
96
+ :'name' => :'String'
92
97
  }
93
98
  end
94
99
 
@@ -102,7 +107,8 @@ module VoucherifySdk
102
107
  :'metadata',
103
108
  :'categories',
104
109
  :'campaign_name',
105
- :'campaign_id'
110
+ :'campaign_id',
111
+ :'name'
106
112
  ])
107
113
  end
108
114
 
@@ -149,6 +155,10 @@ module VoucherifySdk
149
155
  if attributes.key?(:'campaign_id')
150
156
  self.campaign_id = attributes[:'campaign_id']
151
157
  end
158
+
159
+ if attributes.key?(:'name')
160
+ self.name = attributes[:'name']
161
+ end
152
162
  end
153
163
 
154
164
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -182,7 +192,8 @@ module VoucherifySdk
182
192
  metadata == o.metadata &&
183
193
  categories == o.categories &&
184
194
  campaign_name == o.campaign_name &&
185
- campaign_id == o.campaign_id
195
+ campaign_id == o.campaign_id &&
196
+ name == o.name
186
197
  end
187
198
 
188
199
  # @see the `==` method
@@ -194,7 +205,7 @@ module VoucherifySdk
194
205
  # Calculates hash code according to all attributes.
195
206
  # @return [Integer] Hash code
196
207
  def hash
197
- [status, id, object, result, metadata, categories, campaign_name, campaign_id].hash
208
+ [status, id, object, result, metadata, categories, campaign_name, campaign_id, name].hash
198
209
  end
199
210
 
200
211
  # Builds the object from hash
@@ -36,12 +36,15 @@ module VoucherifySdk
36
36
 
37
37
  attr_accessor :categories
38
38
 
39
- # Campaign name
39
+ # Campaign name. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
40
40
  attr_accessor :campaign_name
41
41
 
42
- # Unique campaign ID assigned by Voucherify.
42
+ # Unique campaign ID assigned by Voucherify. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
43
43
  attr_accessor :campaign_id
44
44
 
45
+ # Name of the promotion tier. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body.
46
+ attr_accessor :name
47
+
45
48
  class EnumAttributeValidator
46
49
  attr_reader :datatype
47
50
  attr_reader :allowable_values
@@ -77,7 +80,8 @@ module VoucherifySdk
77
80
  :'metadata' => :'metadata',
78
81
  :'categories' => :'categories',
79
82
  :'campaign_name' => :'campaign_name',
80
- :'campaign_id' => :'campaign_id'
83
+ :'campaign_id' => :'campaign_id',
84
+ :'name' => :'name'
81
85
  }
82
86
  end
83
87
 
@@ -99,7 +103,8 @@ module VoucherifySdk
99
103
  :'metadata' => :'Object',
100
104
  :'categories' => :'Array<CategoryWithStackingRulesType>',
101
105
  :'campaign_name' => :'String',
102
- :'campaign_id' => :'String'
106
+ :'campaign_id' => :'String',
107
+ :'name' => :'String'
103
108
  }
104
109
  end
105
110
 
@@ -111,7 +116,8 @@ module VoucherifySdk
111
116
  :'metadata',
112
117
  :'categories',
113
118
  :'campaign_name',
114
- :'campaign_id'
119
+ :'campaign_id',
120
+ :'name'
115
121
  ])
116
122
  end
117
123
 
@@ -168,6 +174,10 @@ module VoucherifySdk
168
174
  if attributes.key?(:'campaign_id')
169
175
  self.campaign_id = attributes[:'campaign_id']
170
176
  end
177
+
178
+ if attributes.key?(:'name')
179
+ self.name = attributes[:'name']
180
+ end
171
181
  end
172
182
 
173
183
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -204,7 +214,8 @@ module VoucherifySdk
204
214
  metadata == o.metadata &&
205
215
  categories == o.categories &&
206
216
  campaign_name == o.campaign_name &&
207
- campaign_id == o.campaign_id
217
+ campaign_id == o.campaign_id &&
218
+ name == o.name
208
219
  end
209
220
 
210
221
  # @see the `==` method
@@ -216,7 +227,7 @@ module VoucherifySdk
216
227
  # Calculates hash code according to all attributes.
217
228
  # @return [Integer] Hash code
218
229
  def hash
219
- [status, id, object, order, applicable_to, inapplicable_to, result, metadata, categories, campaign_name, campaign_id].hash
230
+ [status, id, object, order, applicable_to, inapplicable_to, result, metadata, categories, campaign_name, campaign_id, name].hash
220
231
  end
221
232
 
222
233
  # Builds the object from hash