Merge pull request #471 from p-zielinski/tests-interface

Changes required to quickly switch between project versions (readme.io, forks)
voucherifyio · Sep 25, 2023 · d600d17 · d600d17
2 parents fd7441e + 7fb9b66
commit d600d17
Show file tree

Hide file tree

Showing 279 changed files with 1,155 additions and 1,141 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.idea/*
diff --git a/automation/Update-Order-Standard-Work.md b/automation/Update-Order-Standard-Work.md
@@ -6,7 +6,7 @@ The following sequence of actions should be taken to successfully update the Dev
 
 > 📘 Important
 >
-> If you create a new version of documentation in readme, such as by copying an existing version and renaming the version name, readme.io will create new page IDs and new category IDs. This means that some pre-work is needed for a new version of the documentation. 
+> If you create a new version of documentation in readme, such as by copying an existing version and renaming the version name, readme.io will create new page IDs and new category IDs. This means that some pre-work is needed for a new version of the documentation.
 
 ### Pre-work 
 

diff --git a/docs/guides/building_blocks/Campaigns.md b/docs/guides/building_blocks/Campaigns.md
@@ -1,7 +1,7 @@
 ---
 title: Campaigns
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: campaigns
 type: basic
 hidden: false
@@ -34,4 +34,4 @@ Usually, voucher campaigns are created in the dashboard by marketers. But someti
 
 ## Promotion tier-based campaigns utils
 
-When it comes to auto-applied promotion discounts, you can use campaigns to [stack](ref:add-promotion-tier-to-campaign) multiple tiers together.
+When it comes to auto-applied promotion discounts, you can use campaigns to [stack](ref:add-promotion-tier-to-campaign) multiple tiers together.
diff --git a/docs/guides/building_blocks/Customer.md b/docs/guides/building_blocks/Customer.md
@@ -1,7 +1,7 @@
 ---
 title: Customers
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: customers
 type: basic
 hidden: false

diff --git a/docs/guides/building_blocks/Distribution.md b/docs/guides/building_blocks/Distribution.md
@@ -1,7 +1,7 @@
 ---
 title: Distribution
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: distribution
 type: basic
 hidden: false
@@ -212,4 +212,4 @@ GET /v1/publications?filters[customer_id][conditions][$in][0]=cust_lUET6gRpO5Wxl
 ```
 ```markdown or another using the junction operator
 GET /v1/publications?filters[customer_id][conditions][$is][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL&filters[customer_id][conditions][$is][1]=cust_aR7NfHusxT7PdTMAKMfWDXnc&filters[junction]=OR
-```
+```
diff --git a/docs/guides/building_blocks/Earning-Rules.md b/docs/guides/building_blocks/Earning-Rules.md
@@ -1,7 +1,7 @@
 ---
 title: Earning Rules
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: earning-rules
 type: basic
 hidden: false

diff --git a/docs/guides/building_blocks/Formula-Builder.md b/docs/guides/building_blocks/Formula-Builder.md
@@ -1,7 +1,7 @@
 ---
 title: Formula Builder
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: formula-builder
 type: basic
 hidden: false

diff --git a/docs/guides/building_blocks/Metadata-Custom-Fields.md b/docs/guides/building_blocks/Metadata-Custom-Fields.md
@@ -1,7 +1,7 @@
 ---
 title: Metadata (custom fields)
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: metadata-custom-fields
 type: basic
 hidden: false

diff --git a/docs/guides/building_blocks/Orders.md b/docs/guides/building_blocks/Orders.md
@@ -1,7 +1,7 @@
 ---
 title: Orders
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: orders
 type: basic
 hidden: false
@@ -56,4 +56,4 @@ Read more about [Stacking discounts](doc:manage-stackable-discounts).
 
 ## Order session
 
-Each time you use particular order in your requests, the API automatically triggers a new session linked to the order id. The session is active during the request and ends asynchronously after the request is completed. The session mechanism provides that the particular order id can be used in one API request at once.
+Each time you use particular order in your requests, the API automatically triggers a new session linked to the order id. The session is active during the request and ends asynchronously after the request is completed. The session mechanism provides that the particular order id can be used in one API request at once.
diff --git a/docs/guides/building_blocks/Products.md b/docs/guides/building_blocks/Products.md
@@ -1,7 +1,7 @@
 ---
 title: Products
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: products
 type: basic
 hidden: false
@@ -242,4 +242,4 @@ Product collections can be managed using your dashboard or dedicated [product co
 > 📘 Useful links
 > 
 > - Learn how to [create Product Collections](https://support.voucherify.io/article/515-products) in your dashboard
-> - Learn more about [Product Collections API](ref:list-products-in-collection)
+> - Learn more about [Product Collections API](ref:list-products-in-collection)
diff --git a/docs/guides/building_blocks/Promotion-Tier.md b/docs/guides/building_blocks/Promotion-Tier.md
@@ -1,7 +1,7 @@
 ---
 title: Promotion Tier
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: promotion-tier
 type: basic
 hidden: false

diff --git a/docs/guides/building_blocks/Redemption.md b/docs/guides/building_blocks/Redemption.md
@@ -1,7 +1,7 @@
 ---
 title: Redemption
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: redemption
 type: basic
 hidden: false
@@ -55,4 +55,4 @@ If you want to reverse this operation, use [rollback](ref:rollback-redemption).
 
 ## Webhooks
 
-Every redemption, successful or failed, generates an event you can listen to (`redemption succeeded`, `redemption failed`, `redemption rollback succeeded`, `redemption rollback failed`). Go to [webhooks](https://docs.voucherify.io/docs/webhooks) to learn more.
+Every redemption, successful or failed, generates an event you can listen to (`redemption succeeded`, `redemption failed`, `redemption rollback succeeded`, `redemption rollback failed`). Go to [webhooks](https://docs.voucherify.io/docs/webhooks) to learn more.
diff --git a/docs/guides/building_blocks/Rewards.md b/docs/guides/building_blocks/Rewards.md
@@ -1,7 +1,7 @@
 ---
 title: Rewards
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: rewards
 type: basic
 hidden: false
@@ -80,4 +80,4 @@ curl -X POST \
 
 Reward and Reward Assignment objects allow for rewarding customers who already collected points in your loyalty program. If you want to learn how to enable your customers to earn points in the first place, follow [here](doc:earning-rules).
 
-If you already have both earning rules and rewards ready, you can create a [loyalty program](doc:loyalty-program).
+If you already have both earning rules and rewards ready, you can create a [loyalty program](doc:loyalty-program).
diff --git a/docs/guides/building_blocks/Validation-Rules.md b/docs/guides/building_blocks/Validation-Rules.md
@@ -1,7 +1,7 @@
 ---
 title: Validation Rules
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: validation-rules
 type: basic
 hidden: false
@@ -447,4 +447,4 @@ or:
         "sales_channel": "page_1"
     }
 }
-```
+```
diff --git a/docs/guides/building_blocks/Vouchers.md b/docs/guides/building_blocks/Vouchers.md
@@ -1,7 +1,7 @@
 ---
 title: Vouchers
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: vouchers
 type: basic
 hidden: false
@@ -238,4 +238,4 @@ You can recharge cards you've sent out to your customers. With our API, you can
 
 Vouchers (along with redemptions, publications, and customers) can be downloaded asynchronously with the export mechanism, see the [API reference](ref:create-export).
 
-Voucher attributes you can export: `code`, `voucher_type`, `value`, `discount_type`, `campaign`, `category`, `start_date`, `expiration_date`, `gift_balance`, `redemption_quantity`, `active`, `qr_code`.
+Voucher attributes you can export: `code`, `voucher_type`, `value`, `discount_type`, `campaign`, `category`, `start_date`, `expiration_date`, `gift_balance`, `redemption_quantity`, `active`, `qr_code`.
diff --git a/docs/guides/building_blocks/Webhooks.md b/docs/guides/building_blocks/Webhooks.md
@@ -1,10 +1,10 @@
 ---
 title: Webhooks
 excerpt: 
-category: 639ba16d677235008f800454
+categorySlug: building-blocks
 slug: webhooks
 type: link
 hidden: false
 order: 12
 link_url: https://support.voucherify.io/article/68-webhooks-notifications
----
+---
diff --git a/docs/guides/campaign_recipes/Locking-Validation-Session.md b/docs/guides/campaign_recipes/Locking-Validation-Session.md
@@ -1,7 +1,7 @@
 ---
 title: Locking Validation Session
 excerpt: Temporary lock the voucher's usage until redemption is successful.
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: locking-validation-session
 type: basic
 hidden: false

diff --git a/docs/guides/campaign_recipes/Loyalty Program.md b/docs/guides/campaign_recipes/Loyalty Program.md
@@ -1,7 +1,7 @@
 ---
 title: Loyalty Program
 excerpt: null
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: loyalty-program
 type: basic
 hidden: false

diff --git a/docs/guides/campaign_recipes/Prepaid-Gift-Cards.md b/docs/guides/campaign_recipes/Prepaid-Gift-Cards.md
@@ -1,7 +1,7 @@
 ---
 title: Prepaid Gift Cards
 excerpt: null
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: prepaid-gift-cards
 type: basic
 hidden: false
@@ -153,4 +153,4 @@ The voucher can be redeemed using the Dashboard as well. Go to the voucher detai
 
 ## Recharge
 
-You can recharge the cards you've sent to customers. With our API, you can edit the balance value by calling [Add Balance](ref:add-gift-voucher-balance) endpoint.
+You can recharge the cards you've sent to customers. With our API, you can edit the balance value by calling [Add Balance](ref:add-gift-voucher-balance) endpoint.
diff --git a/docs/guides/campaign_recipes/Qualifications.md b/docs/guides/campaign_recipes/Qualifications.md
@@ -1,7 +1,7 @@
 ---
 title: Qualification - Checking eligibility
 excerpt: null
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: checking-eligibility
 type: basic
 hidden: false
@@ -12,12 +12,15 @@ order: 1
 
 Sometimes you want to show a customer all the coupons they’re eligible for — taking into account their **attributes** as well as the **current content of their cart**.
 
-Voucherify's Qualifications API helps recommend applicable promotions and coupons in the given customer and order context with filtering options based on campaign category and hierarchy. 
+Voucherify's Qualifications API helps recommend applicable promotions and coupons in the given customer and order context with filtering options based on campaign category and hierarchy.
 
 The qualifications API can be applied (among others) for:
 - Upsell scenarios - showing the customers the discounts available for the customer, encouraging the customer to adjust the cart to conform to the available promotions.
 - Customer wallet - providing a list of vouchers the customer was assigned/received (in Voucherify's terms, a voucher was **published** to the customer) in the past that can be used for the current cart.
 - Strike through price - showing new prices for a list of products after a promotional discount is applied.
+- Showing coupons available for given products in a product catalog
+
+![Product Catalog Coupon](https://files.readme.io/c955bb2-campaign_recipes_qualification_checking_eligibility_productCatalogCoupon.png "Product Catalog Coupon")
 
 ## Scenarios
 
@@ -36,7 +39,7 @@ To specify the types of promotions and codes that you would like to reveal to yo
 
 ## Use Cases
 
-To show a couple of the use cases that are possible with the qualifications API, we'll show it using the following scenarios. Depending on the different scenario, we'll send a slightly different API call and the results will be returned in the context of the scenario. 
+To show a couple of the use cases that are possible with the qualifications API, we'll show it using the following scenarios. Depending on the different scenario, we'll send a slightly different API call and the results will be returned in the context of the scenario.
 
 ### Customer profile
 
@@ -64,6 +67,8 @@ We'll send a qualification API call with several different settings and explain
 
 Since we cannot identify the customer, we can not show redeemables that are out of scope, i.e. that are not dependent on the customer profile.
 
+![Promotions Available for non-logged in customers](https://files.readme.io/3dedd4a-campaign_recipes_qualification_checking_eligibility_availableOffersNotLoggedIn.png "Promotions Available for non-logged in customers")
+
 ```json Request
 {
     "scenario": "ALL",
@@ -213,6 +218,8 @@ This would then return the following:
 | 10% for everyone on entire order | The promotion is available for anyone and gives a 10% discount |
 | 20% for Digital books for VIP customers  | The promotion is available to customers who are VIP customers and is applicable to digital books only |
 
+![Offers Available for logged in customers](https://files.readme.io/fff83fa-campaign_recipes_qualification_checking_eligibility_availableOffersLoggedIn.png "Offers Available for logged in customers")
+
 ```json Request
 {
     "scenario": "ALL",
@@ -610,7 +617,7 @@ This would then return the following:
 ```
 
 > Case 1 Summary
-> 
+>
 > The qualification request returned all of the possible vouchers and redeemables the customer could use right now. You can use the qualifications API request to enhance the customer experience by:
 > - Showing the current promotions available for everyone on the home page
 > - Showing a different set of promotions available for a specific customer on the home page
@@ -627,9 +634,10 @@ All of these scenarios requires one API request per attempt.
 
 We'll send the same request, but with a different `scenario` setting.
 
-
 Only the voucher codes assigned to the customer will be returned. `"scenario": "CUSTOMER_WALLET"`
 
+![Product Catalog Coupon](https://files.readme.io/be0044a-campaign_recipes_qualification_checking_eligibility_myCoupons.png "Product Catalog Coupon")
+
 ```json Request
 {
     "scenario": "CUSTOMER_WALLET",
@@ -857,12 +865,15 @@ Only the voucher codes assigned to the customer will be returned. `"scenario": "
 ```
 
 > Case 2 Summary
-> 
+>
 > The customer wallet scenario returned the list of vouchers the customer can use right now. This mechanism enables you to show the customer, at the cart level, all of his/her vouchers he/she can use, including the gift vouchers and loyalty cards that can be used as the means of payment, enabling your customers to choose a specific reward for themselves, or allowing you to apply the discounts automatically.
 
 ---
 ### Case 3 - Vouchers applicable to specific products
-Only a promotion that is applicable to one of the items in the cart. `"scenario": "PRODUCTS_DISCOUNT"`
+
+Only a promotion that is applicable to items in the cart. `"scenario": "PRODUCTS_DISCOUNT"`
+
+![Product Coupons In Cart](https://files.readme.io/dfd3e1f-campaign_recipes_qualification_checking_eligibility_productCouponsInCart.png "Product Coupons In Cart")
 
 ```json Request
 {
@@ -1201,5 +1212,5 @@ Only a promotion that is applicable to one of the items in the cart. `"scenario"
 ```
 
 > Case 3 Summary
-> 
-> Voucherify will return all the discounts that apply to the products you sent in the order. When a customer is browsing your products and is shown the product listing page, you can send, in the payload, the list of all the products the customer is presented and Voucherify will return all the discounts that apply to these products. The returned results can be visualized, for example, by a striked through price.
+>
+> Voucherify will return all the discounts that apply to the products you sent in the order. When a customer is browsing your products and is shown the product listing page, you can send, in the payload, the list of all the products the customer is presented and Voucherify will return all the discounts that apply to these products. The returned results can be visualized, for example, by a striked-through price.
diff --git a/docs/guides/campaign_recipes/Referral-Program.md b/docs/guides/campaign_recipes/Referral-Program.md
@@ -1,7 +1,7 @@
 ---
 title: Referral Program
 excerpt: null
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: referral-program
 type: link
 hidden: false

diff --git a/docs/guides/campaign_recipes/Stacking-Promotion-Tiers.md b/docs/guides/campaign_recipes/Stacking-Promotion-Tiers.md
@@ -1,7 +1,7 @@
 ---
 title: Stacking Promotion Tiers
 excerpt: 'In this tutorial, you will learn how to validate, redeem, and manage promotion stacks using API.'
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: stacking-promotion-tiers
 type: basic
 hidden: false
@@ -503,4 +503,4 @@ Here is an an example of a promotion stack redemption.
 }
 ```
 
-In the returned `redemptions` array, you can see child redemptions that show redemptions of particular tiers. Discounts from stack tiers are applied consecutively as defined by the stack hierarchy. The hierarchy defines the sequence in which each of the stacked discounts will be applied to the single transaction.
+In the returned `redemptions` array, you can see child redemptions that show redemptions of particular tiers. Discounts from stack tiers are applied consecutively as defined by the stack hierarchy. The hierarchy defines the sequence in which each of the stacked discounts will be applied to the single transaction.
diff --git a/docs/guides/campaign_recipes/Transfer-Loyalty-Points.md b/docs/guides/campaign_recipes/Transfer-Loyalty-Points.md
@@ -1,7 +1,7 @@
 ---
 title: Transfer Loyalty Points
 excerpt: See how to transfer points between loyalty cards.
-category: 639ba16d677235008f80045c
+categorySlug: campaigns-1
 slug: transfer-loyalty-points
 type: basic
 hidden: false

diff --git a/docs/guides/development/API-Reference.md b/docs/guides/development/API-Reference.md
@@ -1,7 +1,7 @@
 ---
 title: API Reference
 excerpt: 
-category: 639ba16d677235008f800447
+categorySlug: development
 slug: api-reference
 type: link
 hidden: false

diff --git a/docs/guides/development/API-Version-Upgrades.md b/docs/guides/development/API-Version-Upgrades.md
@@ -1,7 +1,7 @@
 ---
 title: API Version Upgrades
 excerpt: Keep track of changes and upgrades to the Voucherify API.
-category: 639ba16d677235008f800447
+categorySlug: development
 slug: api-version-upgrades
 type: basic
 hidden: false
@@ -42,4 +42,4 @@ If you’re running an older version, you’ll want to upgrade to take advantage
 
 > 📘 Release Notes
 >
-> [Visit our Help Center](https://support.voucherify.io/article/23-whats-new-in-voucherify) to learn more about the latest Release Notes and new features.
+> [Visit our Help Center](https://support.voucherify.io/article/23-whats-new-in-voucherify) to learn more about the latest Release Notes and new features.