Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pz/types 003 - Categories API #466

Closed
wants to merge 69 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
7825b02
Update OpenAPI.json
p-zielinski Jul 20, 2023
1c206d2
Update OpenAPI.json
p-zielinski Jul 20, 2023
385d85f
Update OpenAPI.json
p-zielinski Jul 20, 2023
02911dd
Update OpenAPI.json
p-zielinski Jul 20, 2023
1f831e1
done
p-zielinski Sep 14, 2023
1c28dc8
Update Changelog.md
p-zielinski Sep 14, 2023
7cc7b04
Merge branch 'master' into pz/types-003
p-zielinski Sep 18, 2023
4aaf7b5
Update OpenAPI.json
p-zielinski Sep 18, 2023
c1587ea
Update OpenAPI.json
p-zielinski Sep 18, 2023
cd9ea9e
Update OpenAPI.json
p-zielinski Sep 18, 2023
4ce93b4
Revert "Update OpenAPI.json"
p-zielinski Sep 18, 2023
7f2b569
Merge remote-tracking branch 'upstream/master'
p-zielinski Sep 18, 2023
ee9cdd0
Merge branch 'master' into pz/types-003
p-zielinski Sep 18, 2023
e63ed85
Update OpenAPI.json
p-zielinski Sep 18, 2023
78c547b
first commit
p-zielinski Sep 19, 2023
fea14a7
category-slugs
p-zielinski Sep 19, 2023
4353d75
script
p-zielinski Sep 19, 2023
afc59f5
slugs2
p-zielinski Sep 19, 2023
91b8e7d
script fix
p-zielinski Sep 19, 2023
91338e2
Update .env.example
p-zielinski Sep 19, 2023
b160114
done
p-zielinski Sep 19, 2023
b1f2b61
in progress
p-zielinski Sep 20, 2023
a3155eb
Update index.js
p-zielinski Sep 20, 2023
ec63957
fix
p-zielinski Sep 20, 2023
bd5c9e2
refectoring
p-zielinski Sep 20, 2023
3bbd825
Update index.js
p-zielinski Sep 20, 2023
8b016ff
script fix, replacing parentDocId
p-zielinski Sep 20, 2023
6990be2
slugChanges
p-zielinski Sep 20, 2023
e18034e
Update OpenAPI.json
p-zielinski Sep 20, 2023
cde85d9
Update OpenAPI.json
p-zielinski Sep 20, 2023
eddcfcb
Update OpenAPI.json
p-zielinski Sep 20, 2023
4f090bc
Update OpenAPI.json
p-zielinski Sep 20, 2023
4b9357b
Update OpenAPI.json
p-zielinski Sep 20, 2023
ddcd2ef
in progress..
p-zielinski Sep 20, 2023
d737dad
Update OpenAPI.json
p-zielinski Sep 21, 2023
f5e6b70
Update OpenAPI.json
p-zielinski Sep 21, 2023
73cbc08
Update OpenAPI.json
p-zielinski Sep 21, 2023
90424d4
Update OpenAPI.json
p-zielinski Sep 21, 2023
ed7f48f
Update OpenAPI.json
p-zielinski Sep 21, 2023
e3c5de7
Update OpenAPI.json
p-zielinski Sep 21, 2023
29be3e7
Update OpenAPI.json
p-zielinski Sep 21, 2023
b933eb1
Update OpenAPI.json
p-zielinski Sep 21, 2023
29303ed
Update OpenAPI.json
p-zielinski Sep 21, 2023
2ec2290
Update OpenAPI.json
p-zielinski Sep 21, 2023
7498730
Update OpenAPI.json
p-zielinski Sep 21, 2023
3e54fbb
Update OpenAPI.json
p-zielinski Sep 21, 2023
5265e81
Update OpenAPI.json
p-zielinski Sep 21, 2023
2747eef
operationsIds
p-zielinski Sep 21, 2023
730bc61
renaming
p-zielinski Sep 21, 2023
edbbef0
Update index.js
p-zielinski Sep 21, 2023
891f9d9
parentDoc -> parentDocSlug
p-zielinski Sep 21, 2023
4d485a4
delete category: id
p-zielinski Sep 21, 2023
04b71c9
remove script :)
p-zielinski Sep 21, 2023
2f945ac
Update .gitignore
p-zielinski Sep 21, 2023
1c4f86d
Update OpenAPI.json
p-zielinski Sep 21, 2023
f77ac6d
Revert "Update OpenAPI.json"
p-zielinski Sep 21, 2023
5bb372c
Update OpenAPI.json
p-zielinski Sep 21, 2023
da98661
update consents
weronika-kurczyna Sep 21, 2023
495abef
order alignment
p-zielinski Sep 21, 2023
78d4092
order (customers)
weronika-kurczyna Sep 21, 2023
ffd9b5c
loyalties
weronika-kurczyna Sep 21, 2023
06a1826
rewards
weronika-kurczyna Sep 21, 2023
fc4afd2
Merge pull request #3 from p-zielinski/wk/update-order-vouchers-custo…
p-zielinski Sep 21, 2023
221825e
Update Update-Order-Standard-Work.md
p-zielinski Sep 21, 2023
05bcb30
Merge remote-tracking branch 'upstream/master'
p-zielinski Sep 22, 2023
991c0b4
merge upstream/master
p-zielinski Sep 22, 2023
01c9a4d
Merge branch 'master' into tests-interface
p-zielinski Sep 22, 2023
4bb93db
delete idea
p-zielinski Sep 22, 2023
4557bfc
Merge branch 'tests-interface' into pz/types-003
p-zielinski Sep 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea/*
26 changes: 25 additions & 1 deletion Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# Changelog

## 20230828

**Added schemas**
- CategoryObject
- CreateCategory
- ResponseCreateCategory
- UpdateCategoryRequest
- ResponseUpdateCategory
- ListCategories

**Endpoints changes**
- `/v1/categories`
- GET
- Response schema was replaced with `ListCategories` (old 20_res_list_categories)
- POST
- Request parameters schema was replaced with `CreateCategory` (old 20_req_create_category)
- Response schema was replaced with `ResponseCreateCategory` (old 20_res_create_category)
- `/v1/categories/{categoryId}`
- GET
- Response schema was replaced with `CategoryObject` (old 20_obj_category_object)
- PUT
- Request parameters schema was replaced with `UpdateCategoryRequest` (old 20_req_update_categories_categoryId)
- Response schema was replaced with `ResponseUpdateCategory` (old 20_obj_category_object)

## 20230823 - New Endpoints

### Introduced new endpoints and related object schemas
Expand Down Expand Up @@ -327,4 +351,4 @@ The following endpoints in the OpenAPI document found in the `paths` object are
`/v1/category-object`
`/v1/metadata-schema-object`
`/v1/location-object`
`/v1/qualification-object`
`/v1/qualification-object`
2 changes: 1 addition & 1 deletion automation/Update-Order-Standard-Work.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Campaigns.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Campaigns
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: campaigns
type: basic
hidden: false
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/guides/building_blocks/Customer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Customers
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: customers
type: basic
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Distribution.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Distribution
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: distribution
type: basic
hidden: false
Expand Down Expand Up @@ -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
```
```
2 changes: 1 addition & 1 deletion docs/guides/building_blocks/Earning-Rules.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Earning Rules
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: earning-rules
type: basic
hidden: false
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/building_blocks/Formula-Builder.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Formula Builder
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: formula-builder
type: basic
hidden: false
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/building_blocks/Metadata-Custom-Fields.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Metadata (custom fields)
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: metadata-custom-fields
type: basic
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Orders.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Orders
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: orders
type: basic
hidden: false
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Products.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Products
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: products
type: basic
hidden: false
Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/guides/building_blocks/Promotion-Tier.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Promotion Tier
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: promotion-tier
type: basic
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Redemption.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Redemption
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: redemption
type: basic
hidden: false
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Rewards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Rewards
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: rewards
type: basic
hidden: false
Expand Down Expand Up @@ -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).
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Validation-Rules.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Validation Rules
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: validation-rules
type: basic
hidden: false
Expand Down Expand Up @@ -447,4 +447,4 @@ or:
"sales_channel": "page_1"
}
}
```
```
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Vouchers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Vouchers
excerpt:
category: 639ba16d677235008f800454
categorySlug: building-blocks
slug: vouchers
type: basic
hidden: false
Expand Down Expand Up @@ -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`.
4 changes: 2 additions & 2 deletions docs/guides/building_blocks/Webhooks.md
Original file line number Diff line number Diff line change
@@ -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
---
---
2 changes: 1 addition & 1 deletion docs/guides/campaign_recipes/Locking-Validation-Session.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/campaign_recipes/Loyalty Program.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Loyalty Program
excerpt: null
category: 639ba16d677235008f80045c
categorySlug: campaigns-1
slug: loyalty-program
type: basic
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/campaign_recipes/Prepaid-Gift-Cards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Prepaid Gift Cards
excerpt: null
category: 639ba16d677235008f80045c
categorySlug: campaigns-1
slug: prepaid-gift-cards
type: basic
hidden: false
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/guides/campaign_recipes/Qualifications.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Qualification - Checking eligibility
excerpt: null
category: 639ba16d677235008f80045c
categorySlug: campaigns-1
slug: checking-eligibility
type: basic
hidden: false
Expand Down Expand Up @@ -1202,4 +1202,4 @@ 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.
2 changes: 1 addition & 1 deletion docs/guides/campaign_recipes/Referral-Program.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Referral Program
excerpt: null
category: 639ba16d677235008f80045c
categorySlug: campaigns-1
slug: referral-program
type: link
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/campaign_recipes/Stacking-Promotion-Tiers.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/guides/campaign_recipes/Transfer-Loyalty-Points.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/development/API-Reference.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: API Reference
excerpt:
category: 639ba16d677235008f800447
categorySlug: development
slug: api-reference
type: link
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/development/API-Version-Upgrades.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/guides/development/Client-Side-API.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Client-side API
excerpt:
category: 639ba16d677235008f800447
categorySlug: development
slug: client-side-api
type: basic
hidden: false
Expand Down Expand Up @@ -38,4 +38,4 @@ Visit :fa-github-alt: [Github repository](https://github.com/voucherifyio/vouche
> You have to activate particular client-side options in the [Project Settings](https://app.voucherify.io/#/app/configuration/proj_f1r5Tpr0J3Ct).

<!-- ![Client-Side Settings](../../assets/img/guides_development_client_side_api_client_side_settings_3.png "Client-Side Settings") -->
![Client-Side Settings](https://files.readme.io/038ab3b-cielnt-side-settings.png "Client-Side Settings")
![Client-Side Settings](https://files.readme.io/038ab3b-cielnt-side-settings.png "Client-Side Settings")
2 changes: 1 addition & 1 deletion docs/guides/development/Error-Codes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Error Codes
excerpt:
category: 639ba16d677235008f800447
categorySlug: development
slug: error-codes
type: link
hidden: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/development/Examples.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Examples
excerpt: Here are some exemplary integrations and third-party guides for you to learn more about Voucherify.
category: 639ba16d677235008f800447
categorySlug: development
slug: examples
type: basic
hidden: false
Expand Down Expand Up @@ -121,4 +121,4 @@ Looking for ready designs for the best promotions experience in your ecommerce s
* [Download Referral UI Kit on Figma](https://www.figma.com/community/file/1039555483777372722)

<!-- ![Figma](../../assets/img/guides_development_examples_figma_5.png "Figma") -->
![Figma](https://files.readme.io/6c4efe5-UI-kit.png "Figma")
![Figma](https://files.readme.io/6c4efe5-UI-kit.png "Figma")
Loading