Skip to content

Commit

Permalink
Changelog for campaigns api and minor fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
jkaliszuk committed Nov 23, 2023
1 parent 68bc9e9 commit 04c8139
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 5 deletions.
60 changes: 60 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,65 @@
# Changelog

## 20231123 - Campaigns API

**Added schemas**
- CampaignResponse
- CampaignVoucher
- CodeConfig
- CodeConfigResponse
- CampaignsImportVoucherLoyaltyCard
- CampaignLoyaltyCardResponse
- CampaignLoyaltyCardResponse
- CampaignLoyaltyCardRequestBody
- LuckyDraw
- CampaignsCreateBase
- CampaignsUpdateBase
- CampaignsUpdateCouponCampaignBase
- CampaignsUpdateDiscountCouponsCampaign
- CampaignsUpdateGiftCampaign
- CampaignsUpdateReferralCampaign
- CampaignsUpdateLoyaltyCampaign
- CampaignsUpdateGiveawayCampaign
- CampaignsUpdatePromotionCampaign
- CampaignsCreateRequestBody
- CampaignsUpdateRequestBody
- CampaignsCreateDiscountCouponsCampaign
- CampaignsCreateReferralCampaign
- CampaignsCreateGiftCampaign
- CampaignsCreateLoyaltyCampaign
- CampaignsCreatePromotionCampaign
- CampaignsCreateGiveawayCampaign
- CampaignsCreateCampaignVoucherWithCodeRequestBody
- CampaignsCreateCampaignVoucherRequestBody
- CampaignsImportVoucherRequestBody
- CampaignsImportVoucherItem
- CampaignsListResponseBody
- DiscountCouponsCampaignVoucher
- ReferralCampaignVoucher
- GiveawayCampaignVoucher
- GiftCampaignVoucher
- LoyaltyCampaignVoucher
- PromotionTierCreateParams
- PromotionTiersList
- LoyaltyTiersExpirationAll

**Deleted schemas**
- 2_obj_campaign_object
- 2_req_create_campaign
- 2_req_create_campaign_discount_voucher
- 2_req_create_campaign_loyalty
- 2_req_create_campaign_gift
- 2_req_create_campaign_referral
- 2_req_create_campaign_promotion
- 2_req_update_campaign
- 2_req_add_vouchers_to_campaign
- 2_req_import_vouchers_to_campaign
- 2_obj_import_vouchers_to_campaign_object
- 2_res_list_campaigns
- 3_res_list_promotion_tiers_from_campaign
- 20_obj_category_object
- e_409_duplicate_found

## 20231117 - Quality Fixes

**Changed schemas**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Add Vouchers to Campaign
title: Add Voucher to Campaign
type: endpoint
categorySlug: voucherify-api
slug: add-vouchers-to-campaign
Expand Down
8 changes: 4 additions & 4 deletions reference/OpenAPI.json
Original file line number Diff line number Diff line change
Expand Up @@ -7741,7 +7741,7 @@
"pattern"
]
},
"CampaigngsImportVoucherLoyaltyCard": {
"CampaignsImportVoucherLoyaltyCard": {
"type": "object",
"description": "Schema model for a campaign loyalty card.",
"title": "Campaign Loyalty Card",
Expand Down Expand Up @@ -8724,7 +8724,7 @@
"description": "Defines the voucher gift details."
},
"loyalty_card": {
"$ref": "#/components/schemas/CampaigngsImportVoucherLoyaltyCard",
"$ref": "#/components/schemas/CampaignsImportVoucherLoyaltyCard",
"description": "Defines the voucher loyalty card details."
}
},
Expand Down Expand Up @@ -45950,7 +45950,7 @@
"tags": [
"CAMPAIGNS API"
],
"summary": "Add Vouchers to Campaign",
"summary": "Add Voucher to Campaign",
"description": "This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional `code_config` parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used.\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](ref:get-async-action).",
"parameters": [
{
Expand Down Expand Up @@ -46108,7 +46108,7 @@
"value": {
"id": "v_EJwB9Wy2aOIsDpWhnl2QBY51OqjQ5Ukg",
"code": "Code3",
"campaign": "Add Vouchers to Campaign",
"campaign": "Add Voucher to Campaign",
"campaign_id": "camp_xxpmFyWO9h9s5cEe7HtmOK5B",
"category": null,
"category_id": "cat_0bb81a481615a37b5e",
Expand Down

0 comments on commit 04c8139

Please sign in to comment.