voucherify 8.0.2 → 8.1.0

data/VoucherifySdk.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ['pawel.rychlik@rspective.pl']
 
   s.summary       = %q{Ruby SDK for Voucherify. More info on http://www.voucherify.io}
-  s.homepage      = 'https://github.com/voucherifyio/sdk-ruby-openapi-based'
+  s.homepage      = 'https://github.com/voucherifyio/voucherify-ruby-sdk'
   s.license       = 'MIT'
   s.required_ruby_version = ">= 2.7"
 

data/__tests__/README.md

@@ -9,6 +9,16 @@ The primary reason for this approach is to ensure that the most critical aspects
 We strongly recommend running the tests using the Dockerfile provided in the root directory. 
 If you prefer to run tests locally, here are the steps you need to follow.
 
+### Environment variables
+
+Create `sdks/ruby/.env` (you can copy `sdks/ruby/.env.example`) and set:
+
+- `VOUCHERIFY_HOST`
+- `X_APP_ID`
+- `X_APP_TOKEN`
+- `X_MANAGEMENT_ID`
+- `X_MANAGEMENT_TOKEN`
+
 ### Requirements 
 
 - all elements described in [main README.md](../README.md) like Ruby and Gem manager
@@ -23,6 +33,14 @@ If you prefer to run tests locally, here are the steps you need to follow.
 4. Go into `__tests__` directory
 5. Run `rspec ./spec` command
 
+### Running with Docker (recommended)
+
+1. Go into `sdks/ruby` directory
+2. Build image: `docker build -t ruby .`
+3. Run tests: `docker run --rm ruby`
+
+From repo root, you can also run: `npm run test-ruby-sdk`.
+
 **Note that running tests will affect your Voucherify project data. Run tests only on development projects.**
 
 ## Contributing

data/__tests__/lib/campaigns.rb

@@ -1,6 +1,7 @@
 require_relative 'utils.rb'
 require 'VoucherifySdk'
 require 'json'
+require 'tempfile'
 
 def create_validation_rule_applicable_to(validation_rules_api_instance, product_id)
     begin
@@ -144,5 +145,56 @@ def add_vouchers_to_campaign(campaigns_api_instance, campaign_id, voucher_count)
     rescue VoucherifySdk::ApiError => e
       return nil
     end
-  end
+end
+
+def create_discount_campaign_with_expiration(campaigns_api_instance, expiration_date)
+    expiration_value = expiration_date.respond_to?(:utc) ? expiration_date.utc.iso8601 : expiration_date
+
+    campaigns_api_instance.create_campaign({
+        campaigns_create_request_body: VoucherifySdk::CampaignsCreateRequestBody.new({
+            campaign_type: "DISCOUNT_COUPONS",
+            name: generate_random_string(),
+            type: "AUTO_UPDATE",
+            expiration_date: expiration_value,
+            voucher: VoucherifySdk::CampaignsCreateRequestBodyVoucher.new({
+                type: 'DISCOUNT_VOUCHER',
+                discount: VoucherifySdk::Discount.new({
+                    type: 'AMOUNT',
+                    amount_off: 1000
+                })
+            })
+        })
+    })
+end
+
+def update_campaign_expiration_to_null(campaigns_api_instance, campaign_id)
+    campaigns_api_instance.update_campaign(campaign_id, {
+        campaigns_update_request_body: {
+            expiration_date: nil
+        }
+    })
+    true
+end
+
+def import_vouchers_to_campaign_using_csv(campaigns_api_instance, campaign_id, voucher_codes)
+    file = Tempfile.new(['vouchers_import', '.csv'])
+
+    begin
+        file.write("code\n")
+        voucher_codes.each do |code|
+            file.write("#{code}\n")
+        end
+        file.rewind
+
+        csv_file = File.new(file.path)
+        result = campaigns_api_instance.import_vouchers_to_campaign_using_csv(campaign_id, {
+            file: csv_file
+        })
+        csv_file.close
+        result
+    ensure
+        file.close
+        file.unlink
+    end
+end
 

data/__tests__/lib/config.rb

@@ -60,6 +60,10 @@ module Config
       return VoucherifySdk::EventsApi.new()
     end
 
+    def self.async_actions_api_instance
+      return VoucherifySdk::AsyncActionsApi.new()
+    end
+
     def self.order_api_instance
       return VoucherifySdk::OrdersApi.new()
     end
@@ -71,5 +75,22 @@ module Config
     def self.vouchers_api_instance
       return VoucherifySdk::VouchersApi.new()
     end
+
+    def self.management_api_instance
+      management_config = VoucherifySdk::Configuration.new
+      management_config.api_key['X-Management-Id'] = ENV['X_MANAGEMENT_ID']
+      management_config.api_key['X-Management-Token'] = ENV['X_MANAGEMENT_TOKEN']
+      management_config.host = ENV['VOUCHERIFY_HOST'] || 'https://api.voucherify.io'
+
+      return VoucherifySdk::ManagementApi.new(VoucherifySdk::ApiClient.new(management_config))
+    end
+
+    def self.management_credentials_configured?
+      return !ENV['X_MANAGEMENT_ID'].to_s.empty? && !ENV['X_MANAGEMENT_TOKEN'].to_s.empty?
+    end
+
+    def self.management_project_id
+      return ENV['PROJECT_ID']
+    end
 end
 

data/__tests__/lib/loyalties.rb

@@ -12,7 +12,7 @@ def update_loyalty_card_balance(loyalties_api_instance, memberId)
     return updated_loyalty_member_card
 
   rescue VoucherifySdk::ApiError => e
-    retun nil
+    return nil
   end
 end
 
@@ -28,5 +28,5 @@ def list_loyalty_card_transactions(loyalties_api_instance, memberId)
 
   rescue VoucherifySdk::ApiError => e
     return nil
-  end 
+  end
 end

data/__tests__/lib/utils.rb

@@ -6,4 +6,30 @@ end
 
 def generate_random_voucher_codes(base_code, count, length=6)
   (1..count).map { "#{base_code}-#{generate_random_string(length)}" }
-end
+end
+
+# Polls the async actions endpoint until the action reaches a terminal state.
+# Returns the final AsyncActionGetResponseBody when it succeeds, raises otherwise.
+def wait_for_async_action(async_actions_api_instance, async_action_id, max_attempts: 10, delay_seconds: 2)
+  attempt = 0
+
+  loop do
+    attempt += 1
+    sleep(delay_seconds)
+
+    action = async_actions_api_instance.get_async_action(async_action_id)
+
+    operation_status = action.operation_status.to_s.upcase
+    status = action.status.to_s.upcase
+
+    return action if operation_status == 'SUCCESS' || status == 'DONE'
+
+    if operation_status == 'FAILED' || status == 'FAILED'
+      raise "Async action #{async_action_id} failed (status=#{status}, operation_status=#{operation_status})"
+    end
+
+    if attempt >= max_attempts
+      raise "Async action #{async_action_id} did not finish after #{max_attempts} attempts (status=#{status}, operation_status=#{operation_status})"
+    end
+  end
+end

data/__tests__/spec/02_campaigns_spec.rb

@@ -9,6 +9,7 @@ RSpec.describe 'Campaigns API', :order => :defined do
   before(:each) do
     @campaigns_api_instance = Config.campaigns_api_instance()
     @validation_rules_api_instance = Config.validation_rules_api_instance()
+    @async_actions_api_instance = Config.async_actions_api_instance()
     @voucherify_data = VoucherifyData.instance()
   end
 
@@ -44,7 +45,7 @@ RSpec.describe 'Campaigns API', :order => :defined do
     @voucherify_data.set_discount_campaign(created_discount_campaign)
   end
 
-  it 'create a promotion campaign', :order => :thrid do
+  it 'create a promotion campaign', :order => :third do
     created_promotion_campaign = create_promotion_campaign(@campaigns_api_instance)
 
     snapshot_name = 'campaigns/created_promotion_campaign'
@@ -125,9 +126,39 @@ RSpec.describe 'Campaigns API', :order => :defined do
     expect(validate_deep_match(filtered_validation_rule_snapshot, validation_rule)).to be true
 
     voucher = @campaigns_api_instance.add_vouchers_to_campaign(campaign.id, {
-        vouchers_count: 1,
+      vouchers_count: 1,
     })
 
     @voucherify_data.set_voucher_with_more_than_validation_rule(voucher)
   end
+
+  it 'import vouchers to campaign using csv', :order => :tenth do
+    voucher_codes = Array.new(3) { generate_random_string(8) }
+    imported_vouchers = import_vouchers_to_campaign_using_csv(@campaigns_api_instance, $created_discount_campaign.id, voucher_codes)
+
+    expect(imported_vouchers).not_to be_nil
+    expect(imported_vouchers.async_action_id).not_to be_nil
+
+    finished_action = wait_for_async_action(@async_actions_api_instance, imported_vouchers.async_action_id)
+
+    expect(finished_action).not_to be_nil
+    expect(finished_action.id).to eq(imported_vouchers.async_action_id)
+  end
+
+  it 'update campaign expiration_date to null', :order => :eleventh do
+    expiration_date = Time.now.utc + 86400
+    created_campaign = create_discount_campaign_with_expiration(@campaigns_api_instance, expiration_date)
+
+    expect(created_campaign).not_to be_nil
+    expect(created_campaign.expiration_date).not_to be_nil
+
+    updated_to_null = update_campaign_expiration_to_null(@campaigns_api_instance, created_campaign.id)
+
+    expect(updated_to_null).to be true
+
+    campaign_after_update = @campaigns_api_instance.get_campaign(created_campaign.id)
+
+    expect(campaign_after_update).not_to be_nil
+    expect(campaign_after_update.expiration_date).to be_nil
+  end
 end

data/__tests__/spec/04_publications_spec.rb

@@ -16,9 +16,7 @@ RSpec.describe 'Publications API', :order => :defined do
           customer: VoucherifySdk::Customer.new({
             id: @voucherify_data.get_customer().id
           }),
-          campaign: VoucherifySdk::CreatePublicationCampaign.new({
-              name: @voucherify_data.get_discount_campaign().name
-            })
+          voucher: @voucherify_data.get_voucher().code
           })
       })
 
@@ -28,4 +26,19 @@ RSpec.describe 'Publications API', :order => :defined do
     expect(publication).not_to be_nil
     expect(validate_deep_match(filtered_snapshot, publication)).to be true
   end
+
+  it 'publish loyalty card to customer', :order => :second do
+    publication = @publications_api_instance.create_publication({
+      join_once: true,
+      publications_create_request_body: VoucherifySdk::PublicationsCreateRequestBody.new({
+        customer: VoucherifySdk::Customer.new({
+          id: @voucherify_data.get_customer().id
+        }),
+        voucher: @voucherify_data.get_loyalty_card().code
+      })
+    })
+
+    expect(publication).not_to be_nil
+    expect(publication.voucher.code).to eq(@voucherify_data.get_loyalty_card().code)
+  end
 end

data/__tests__/spec/07_vouchers_spec.rb

@@ -8,6 +8,7 @@ require_relative 'support/validate_deep_match'
 RSpec.describe 'Vouchers API', :order => :defined do
   before(:each) do
     @vouchers_api_instance = Config.vouchers_api_instance()
+    @publications_api_instance = Config.publications_api_instance()
     @voucherify_data = VoucherifyData.instance()
   end
 
@@ -31,7 +32,7 @@ RSpec.describe 'Vouchers API', :order => :defined do
     expect(validate_deep_match(filtered_snapshot, voucher)).to be true
   end
 
-  it 'enable voucher previously created', :order => :thrird do
+  it 'enable voucher previously created', :order => :third do
     voucher = @vouchers_api_instance.enable_voucher(@voucherify_data.get_voucher().code)
 
     snapshot_name = 'vouchers/enabled_previously_created_voucher'
@@ -41,14 +42,32 @@ RSpec.describe 'Vouchers API', :order => :defined do
     expect(validate_deep_match(filtered_snapshot, voucher)).to be true
   end
 
-  it 'update loyalty card balance', :order => :fourth do
+  it 'publish loyalty card', :order => :fourth do
+    loyalty_card = @voucherify_data.get_loyalty_card()
+    customer = @voucherify_data.get_customer()
+
+    publication = @publications_api_instance.create_publication({
+      publications_create_request_body: VoucherifySdk::PublicationsCreateRequestBody.new({
+        voucher: loyalty_card.code,
+        customer: VoucherifySdk::Customer.new({
+          id: customer.id
+        })
+      })
+    })
+
+    expect(publication).not_to be_nil
+  end
+
+  it 'update loyalty card balance', :order => :fifth do
+    loyalty_card = @voucherify_data.get_loyalty_card()
+
     vouchers_balance_update_request_body = VoucherifySdk::VouchersBalanceUpdateRequestBody.new({
         source_id: generate_random_string(),
         amount: 10000,
         reason: "Regular customer"
       })
 
-    response = @vouchers_api_instance.update_voucher_balance(@voucherify_data.get_loyalty_card().code, vouchers_balance_update_request_body)
+    response = @vouchers_api_instance.update_voucher_balance(loyalty_card.code, vouchers_balance_update_request_body)
 
     snapshot_name = 'vouchers/updated_loyalty_card_balance'
     filtered_snapshot = get_snapshot_without_uniq_keys(snapshot_name)

data/__tests__/spec/12_validation_rules_spec.rb

@@ -19,21 +19,7 @@ RSpec.describe 'Validation Rules API', :order => :defined do
       related_object_type: "voucher",
       related_object_id: voucher.code
     })
-
-    created_validation_rule_assignment = @validation_rules_api_instance.create_validation_rule_assignment(validation_rule.id, {
-        validation_rules_assignments_create_request_body: validationRulesAssignmentsCreateRequestBody
-    })
-    snapshot_name = 'validation_rules/created_validation_rule_assignment'
-    filtered_snapshot = get_snapshot_without_uniq_keys(snapshot_name)
-
-    expect(created_validation_rule_assignment).not_to be_nil
-    expect(created_validation_rule_assignment.id).not_to be_nil
-    expect(created_validation_rule_assignment.created_at).not_to be_nil
-    expect(created_validation_rule_assignment.rule_id).to eq(validation_rule.id)
-    expect(created_validation_rule_assignment.related_object_id).to eq(voucher.id)
-    expect(created_validation_rule_assignment.related_object_type).to eq("voucher")
-    expect(created_validation_rule_assignment.object).to eq("validation_rules_assignment")
-    expect(validate_deep_match(filtered_snapshot, created_validation_rule_assignment)).to be true
+    # TODO
   end
 
 end

data/__tests__/spec/13_management_spec.rb

@@ -0,0 +1,110 @@
+require_relative '../lib/config.rb'
+require 'VoucherifySdk'
+
+RSpec.describe 'Management API', :order => :defined do
+  before(:each) do
+    skip 'Set X_MANAGEMENT_ID and X_MANAGEMENT_TOKEN to run management tests' unless Config.management_credentials_configured?
+    @management_api_instance = Config.management_api_instance()
+  end
+
+  TEST_SCHEMA_RELATED_OBJECT = 'test-ruby-sdk'.freeze
+
+  $management_project_id = nil
+  $metadata_schema_to_update = nil
+
+  it 'list projects', :order => :first do
+    projects_response = @management_api_instance.list_projects()
+    project_from_response = projects_response.data&.first
+
+    $management_project_id = project_from_response&.id
+
+    expect(projects_response).not_to be_nil
+    expect(projects_response.object).to eq('list')
+    expect(projects_response.data).to be_a(Array)
+    expect($management_project_id).not_to be_nil
+  end
+
+  it 'list metadata schemas for selected project', :order => :second do
+    metadata_schemas_response = @management_api_instance.list_metadata_schemas1($management_project_id)
+
+    expect(metadata_schemas_response).not_to be_nil
+    expect(metadata_schemas_response.object).to eq('list')
+    expect(metadata_schemas_response.data).to be_a(Array)
+
+    test_metadata_schema = metadata_schemas_response.data&.find do |schema|
+      schema.related_object == TEST_SCHEMA_RELATED_OBJECT
+    end
+
+    if test_metadata_schema.nil? ||
+       !test_metadata_schema.properties.is_a?(Hash) ||
+       test_metadata_schema.properties.empty?
+      test_metadata_schema = ensure_test_metadata_schema(@management_api_instance, $management_project_id)
+    end
+
+    $metadata_schema_to_update = test_metadata_schema
+
+    expect($metadata_schema_to_update).not_to be_nil
+    expect($metadata_schema_to_update.related_object).to eq(TEST_SCHEMA_RELATED_OBJECT)
+    expect($metadata_schema_to_update.properties).to be_a(Hash)
+    expect($metadata_schema_to_update.properties).not_to be_empty
+  end
+
+  it 'update metadata schema', :order => :third do
+    property_name, property_definition = $metadata_schema_to_update.properties&.first
+    expect(property_name).not_to be_nil
+    expect(property_definition).not_to be_nil
+
+    update_request_body = VoucherifySdk::ManagementProjectsMetadataSchemasUpdateRequestBody.new({
+      allow_defined_only: $metadata_schema_to_update.allow_defined_only,
+      properties: {
+        property_name => VoucherifySdk::ManagementProjectsMetadataSchemaDefinition.new(
+          property_definition.to_hash.transform_keys(&:to_sym)
+        )
+      }
+    })
+
+    updated_metadata_schema = @management_api_instance.update_metadata_schema(
+      $management_project_id,
+      $metadata_schema_to_update.id,
+      {
+        management_projects_metadata_schemas_update_request_body: update_request_body
+      }
+    )
+
+    expect(updated_metadata_schema).not_to be_nil
+    expect(updated_metadata_schema.id).to eq($metadata_schema_to_update.id)
+    expect(updated_metadata_schema.related_object).to eq($metadata_schema_to_update.related_object)
+    expect(updated_metadata_schema.properties.keys).to include(property_name)
+  end
+
+  def ensure_test_metadata_schema(management_api_instance, project_id)
+    create_request_body = VoucherifySdk::ManagementProjectsMetadataSchemasCreateRequestBody.new({
+      related_object: TEST_SCHEMA_RELATED_OBJECT,
+      allow_defined_only: false,
+      properties: {
+        'Test' => VoucherifySdk::ManagementProjectsMetadataSchemaDefinition.new({
+          type: 'string',
+          array: false,
+          optional: true,
+          object_type: nil
+        })
+      }
+    })
+
+    management_api_instance.create_metadata_schema(
+      project_id,
+      {
+        management_projects_metadata_schemas_create_request_body: create_request_body
+      }
+    )
+
+    sleep(2)
+
+    metadata_schemas_response = management_api_instance.list_metadata_schemas1(project_id)
+    metadata_schemas_response.data&.find do |schema|
+      schema.related_object == TEST_SCHEMA_RELATED_OBJECT &&
+        schema.properties.is_a?(Hash) &&
+        !schema.properties.empty?
+    end
+  end
+end

data/__tests__/spec/14_additional_properties_spec.rb

@@ -0,0 +1,28 @@
+require 'VoucherifySdk'
+
+RSpec.describe 'Models with additional properties', :order => :defined do
+  it 'build metadata schema with regular fields and dynamic properties', :order => :first do
+    schema_payload = {
+      'id' => 'meta_test_schema',
+      'related_object' => 'customer',
+      'allow_defined_only' => false,
+      'object' => 'metadata_schema',
+      'properties' => {
+        'dynamic_field' => {
+          'type' => 'string',
+          'optional' => true
+        }
+      }
+    }
+
+    metadata_schema = VoucherifySdk::ManagementProjectsMetadataSchema.build_from_hash(schema_payload)
+    serialized_metadata_schema = metadata_schema.to_hash
+
+    expect(metadata_schema.id).to eq('meta_test_schema')
+    expect(metadata_schema.related_object).to eq('customer')
+    expect(metadata_schema.properties).to be_a(Hash)
+    expect(metadata_schema.properties['dynamic_field']).to be_a(VoucherifySdk::ManagementProjectsMetadataSchemaDefinition)
+    expect(metadata_schema.properties['dynamic_field'].type).to eq('string')
+    expect(serialized_metadata_schema[:properties].keys).to include('dynamic_field')
+  end
+end

data/__tests__/spec/support/get_snapshot_without_uniq_keys.rb

@@ -2,7 +2,7 @@
 require_relative 'snapshot_helper'
 
 def get_snapshot_without_uniq_keys(snapshot_name, keys_to_remove = nil)
-  keys_to_remove ||= ['id', 'created_at', 'updated_at', 'name', 'rule_id', 'customer_id', 'related_object_id', 'source_id', 'product_id', 'promotion_id', 'campaign_id', 'banner', 'code', 'date', 'voucher_id', 'rule_id', 'related_object_id', 'url', 'tracking_id', 'vouchers_id', 'holder_id']
+  keys_to_remove ||= ['id', 'created_at', 'updated_at', 'name', 'rule_id', 'customer_id', 'related_object_id', 'source_id', 'product_id', 'promotion_id', 'campaign_id', 'banner', 'code', 'date', 'voucher_id', 'rule_id', 'related_object_id', 'url', 'tracking_id', 'vouchers_id', 'holder_id', 'join_once', 'orders', 'segments', 'daily_events']
 
   # Load snapshot
   snapshot = load_snapshot(snapshot_name)

data/docs/AccessSettings.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::AccessSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assign** | [**AccessSettingsAssign**](AccessSettingsAssign.md) |  | [optional] |
+| **unassign** | [**AccessSettingsUnassign**](AccessSettingsUnassign.md) |  | [optional] |
+

data/docs/AccessSettingsAssign.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::AccessSettingsAssign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **areas_ids** | **Array<String>** | List all area IDs to which the campaign will be assigned. | [optional] |
+| **area_stores_ids** | **Array<String>** | List all store IDs to which the campaign will be assigned. | [optional] |
+| **area_all_stores_ids** | **Array<String>** | List all area IDs where the campaign is assigned to all stores in the area. This assignment is not equal to the assignment to all `area_stores_ids` listed separately. | [optional] |
+

data/docs/AccessSettingsUnassign.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::AccessSettingsUnassign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **areas_ids** | **Array<String>** | List all area IDs from which the campaign will be unassigned. | [optional] |
+| **area_stores_ids** | **Array<String>** | List all store IDs from which the campaign will be unassigned. | [optional] |
+| **area_all_stores_ids** | **Array<String>** | List all area IDs where the campaign will be unassigned from all stores in the area. This unassignment is not equal to the unassignment from all `area_stores_ids` listed separately. | [optional] |
+

data/docs/ApplicableTo.md

@@ -9,16 +9,33 @@
 | **source_id** | **String** | The source identifier from your inventory system. | [optional] |
 | **product_id** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] |
 | **product_source_id** | **String** | Parent product's source ID from your inventory system. | [optional] |
-| **strict** | **Boolean** |  | [optional] |
 | **price** | **Float** | New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price. | [optional] |
-| **price_formula** | **Float** | Formula used to calculate the discounted price of an item. | [optional] |
+| **price_formula** | **Float** | Formula used to dynamically calculate the discounted price of an item. | [optional] |
 | **effect** | [**ApplicableToEffect**](ApplicableToEffect.md) |  |  |
 | **quantity_limit** | **Integer** | The maximum number of units allowed to be discounted per order line item. | [optional] |
 | **aggregated_quantity_limit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] |
 | **amount_limit** | **Integer** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
 | **aggregated_amount_limit** | **Integer** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] |
-| **order_item_indices** | **Array<Integer>** | Determines the order in which the discount is applied to the products or SKUs sent in the `order` object in the request. The counting begins from `0`. | [optional] |
+| **product_campaign_quantity_limit** | **Integer** | Limits the number of discounted item units (product, SKU, collection) that all customers can receive in a given campaign. If a product is selected, the limit covers all discounts across all SKUs belonging to that product. If a product collection is selected, the limit covers all products/SKUs within the collection.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_campaign_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per campaign.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_customer_campaign_quantity_limit** | **Integer** | Limits the number of discounted item units (product, SKU, collection) that one customer can receive in a given campaign.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_customer_campaign_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per customer in a campaign.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_campaign_quantity_limit** | **Integer** | Limits the number of discounted item units of a given product in a collection that all customers can receive in a given campaign.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_campaign_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per campaign for a product in a collection.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_customer_campaign_quantity_limit** | **Integer** | Limits the number of discounted item units of a given product in a collection that one customer can receive in a campaign.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_customer_campaign_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per customer for a product in a collection.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_promotion_tier_quantity_limit** | **Integer** | Limits the number of discounted item units that all customers can receive in a promotion tier.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_promotion_tier_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per promotion tier.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_customer_promotion_tier_quantity_limit** | **Integer** | Limits the number of discounted item units that one customer can receive in a given promotion tier.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_customer_promotion_tier_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per customer in a promotion tier.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_promotion_tier_quantity_limit** | **Integer** | Limits the number of discounted item units of a given product in a collection that all customers can receive in a given promotion tier.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_promotion_tier_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per promotion tier for a product in a collection.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_customer_promotion_tier_quantity_limit** | **Integer** | Limits the number of discounted item units of a given product in a collection that one customer can receive in a promotion tier.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **product_in_collection_customer_promotion_tier_quantity_limit_formula** | **String** | Formula used to dynamically calculate the maximum units per customer in a promotion tier for a product in a collection.  This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more. | [optional] |
+| **order_item_indices** | **Array<Integer>** | Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on. | [optional] |
+| **order_item_units** | [**Array<ApplicableToOrderItemUnitsItem>**](ApplicableToOrderItemUnitsItem.md) | Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request. | [optional] |
 | **repeat** | **Integer** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional] |
 | **skip_initially** | **Integer** | Determines how many items are skipped before the discount is applied. | [optional] |
-| **target** | **String** | Determines to which kinds of objects the discount is applicable. `\"ITEM\"` includes products and SKUs. | [optional] |
+| **target** | **String** | Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line. | [optional] |
+| **strict** | **Boolean** |  | [optional] |
 

data/docs/ApplicableToOrderItemUnitsItem.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::ApplicableToOrderItemUnitsItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | Number assigned to the order line item in accordance with the order sent in the request. | [optional] |
+| **units** | **Array<Integer>** | Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but `units_limit_exceeded: true`. However, the discount is calculated properly for all relevant units. | [optional] |
+| **units_limit_exceeded** | **Boolean** | Returned as `true` only when the sum total of `quantity` of all order items exceeds 1000. | [optional] |
+

data/docs/ApplicationDetailsItem.md

@@ -0,0 +1,14 @@
+# VoucherifySdk::ApplicationDetailsItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_index** | **Integer** | Index number of the source item that is replaced. The enumeration starts from `0`, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, `source_index` equals `3`. | [optional] |
+| **source_applied_quantity** | **Integer** | Number of source units that are replaced. | [optional] |
+| **source_applied_quantity_amount** | **Integer** | Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity. | [optional] |
+| **target_index** | **Integer** | Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, `target_index` equals `3`, as enumeration starts from `0`. | [optional] |
+| **target_applied_quantity** | **Integer** | Number of added target units that are replacements. | [optional] |
+| **target_applied_quantity_amount** | **Integer** | Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity. | [optional] |
+| **target_applied_discount_amount** | **Integer** | Discount amount applied to the target item with regard to the replacement. Equals the `target_applied_quantity_amount` minus `source_applied_quantity_amount`. | [optional] |
+

data/docs/AreaStoreCampaignAssignment.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Unique identifier of the campaign assignment. | [optional] |
 | **area_id** | **String** | Unique identifier of the area to which the campaign is assigned. | [optional] |
+| **all_stores** | **Boolean** | Determines if the campaign is assigned to all of the stores in the area, i.e. if an area ID is passed in the `access_settings.assign.area_all_stores_ids` in the request. | [optional] |
 | **area_store_id** | **String** | Unique identifier of the store to which the campaign is assigned. | [optional] |
 | **created_at** | **Time** | Date and time when the assignment was made. The value is shown in the ISO 8601 format. | [optional] |
 | **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores. | [optional][default to 'area_store_campaign_assignment'] |

data/docs/AsyncActionsApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 Get Async Action
 
-Check the result of a scheduled asynchronous operation.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).       
+Check the result of a scheduled asynchronous operation.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action.        
 
 ### Examples
 
@@ -72,7 +72,7 @@ end
 
 List Async Actions
 
-Track asynchronous operations scheduled in your project.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).       
+Track asynchronous operations scheduled in your project.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action.       
 
 ### Examples