|
| 1 | +# Interface Change Summary: 0.0.1-alpha.3 |
| 2 | + |
| 3 | +## Modified files |
| 4 | +### `catalog/brands_catalog.v3.ts` |
| 5 | + |
| 6 | +components.parameters: |
| 7 | +```diff |
| 8 | ++ readonly DirectionQuery: "asc" | "desc"; |
| 9 | +``` |
| 10 | + |
| 11 | +operations.getBrands.parameters.query: |
| 12 | +```diff |
| 13 | ++ readonly direction?: components["parameters"]["DirectionQuery"]; |
| 14 | +``` |
| 15 | + |
| 16 | +### `pages.v3.ts` |
| 17 | + |
| 18 | +components.schemas.pageMeta: |
| 19 | +```diff |
| 20 | +- readonly meta_keywords: string; |
| 21 | ++ readonly meta_keywords: string | null; |
| 22 | +- readonly meta_description: string; |
| 23 | ++ readonly meta_description: string | null; |
| 24 | +``` |
| 25 | + |
| 26 | +components.schemas.searchKeywords: |
| 27 | +```diff |
| 28 | +- readonly search_keywords: string; |
| 29 | ++ readonly search_keywords: string | null; |
| 30 | +``` |
| 31 | + |
| 32 | +### `promotions.v3.ts` |
| 33 | + |
| 34 | +components.schemas: |
| 35 | +```diff |
| 36 | ++ readonly CreatedFrom: "react_ui" | "legacy_ui" | "api"; |
| 37 | +- readonly PromotionCoupon: components["schemas"]["PromotionBase"] & { |
| 38 | ++ readonly PatchCouponPromotion: components["schemas"]["PromotionBase"] & { |
| 39 | +- readonly PromotionAutomatic: components["schemas"]["PromotionBase"]; |
| 40 | ++ readonly DraftCouponPromotion: components["schemas"]["PromotionBase"] & { |
| 41 | +``` |
| 42 | + |
| 43 | +components.schemas.PromotionBase: |
| 44 | +```diff |
| 45 | +- readonly name: string; |
| 46 | ++ readonly name?: string; |
| 47 | +- readonly rules: readonly components["schemas"]["Rule"][]; |
| 48 | ++ readonly rules?: readonly components["schemas"]["Rule"][]; |
| 49 | +``` |
| 50 | + |
| 51 | +components.schemas.PatchCouponPromotion: |
| 52 | +```diff |
| 53 | ++ readonly codes?: components["schemas"]["CouponCode"]; |
| 54 | +``` |
| 55 | + |
| 56 | +components.schemas.DraftCouponPromotion: |
| 57 | +```diff |
| 58 | ++ readonly codes?: components["schemas"]["CouponCode"]; |
| 59 | ++ readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; |
| 60 | ++ readonly redemption_type: "COUPON"; |
| 61 | ++ }; |
| 62 | ++ readonly SavedCouponPromotion: WithRequired<components["schemas"]["PromotionBase"], "id" | "name" | "channels" | "customer" | "rules" | "notifications" | "stop" | "currency_code" | "redemption_type" | "current_uses" | "start_date" | "status" | "can_be_used_with_other_promotions"> & { |
| 63 | ++ readonly id: number; |
| 64 | ++ readonly created_from: components["schemas"]["CreatedFrom"]; |
| 65 | ++ readonly codes?: components["schemas"]["CouponCode"]; |
| 66 | ++ readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; |
| 67 | ++ readonly redemption_type: "COUPON"; |
| 68 | ++ readonly multiple_codes?: { |
| 69 | ++ readonly has_multiple_codes: boolean; |
| 70 | ++ }; |
| 71 | ++ }; |
| 72 | ++ readonly PatchAutomaticPromotion: components["schemas"]["PromotionBase"]; |
| 73 | ++ readonly DraftAutomaticPromotion: WithRequired<components["schemas"]["PromotionBase"], "redemption_type" | "name" | "rules"> & { |
| 74 | ++ readonly redemption_type: "AUTOMATIC"; |
| 75 | ++ }; |
| 76 | ++ readonly SavedAutomaticPromotion: WithRequired<components["schemas"]["PromotionBase"], "id" | "name" | "channels" | "customer" | "rules" | "notifications" | "stop" | "currency_code" | "redemption_type" | "current_uses" | "start_date" | "status" | "can_be_used_with_other_promotions"> & { |
| 77 | ++ readonly redemption_type: "AUTOMATIC"; |
| 78 | ++ readonly id: number; |
| 79 | ++ readonly created_from: components["schemas"]["CreatedFrom"]; |
| 80 | ++ }; |
| 81 | +``` |
| 82 | + |
| 83 | +components.schemas.CollectionMeta: |
| 84 | +```diff |
| 85 | +- readonly pagination?: components["schemas"]["Pagination"]; |
| 86 | ++ readonly pagination: components["schemas"]["Pagination"]; |
| 87 | +``` |
| 88 | + |
| 89 | +components.schemas.Pagination: |
| 90 | +```diff |
| 91 | +- readonly total?: number; |
| 92 | ++ readonly total: number; |
| 93 | +- readonly count?: number; |
| 94 | ++ readonly count: number; |
| 95 | +- readonly per_page?: number; |
| 96 | ++ readonly per_page: number; |
| 97 | +- readonly current_page?: number; |
| 98 | ++ readonly current_page: number; |
| 99 | +- readonly total_pages?: number; |
| 100 | ++ readonly total_pages: number; |
| 101 | +- readonly links?: { |
| 102 | ++ readonly links: { |
| 103 | +``` |
| 104 | + |
| 105 | +components.schemas.CouponCode: |
| 106 | +```diff |
| 107 | +- readonly id?: number; |
| 108 | ++ readonly id: number; |
| 109 | +- readonly current_uses?: number; |
| 110 | ++ readonly current_uses: number; |
| 111 | +- readonly created?: string; |
| 112 | ++ readonly created: string; |
| 113 | +``` |
| 114 | + |
| 115 | +components.responses.PromotionsCollectionResponse.content."application/json": |
| 116 | +```diff |
| 117 | +- readonly data?: readonly (components["schemas"]["PromotionAutomatic"] | components["schemas"]["PromotionCoupon"])[]; |
| 118 | ++ readonly data: readonly (components["schemas"]["SavedAutomaticPromotion"] | components["schemas"]["SavedCouponPromotion"])[]; |
| 119 | +- readonly meta?: components["schemas"]["CollectionMeta"]; |
| 120 | ++ readonly meta: components["schemas"]["CollectionMeta"]; |
| 121 | +``` |
| 122 | + |
| 123 | +components.responses.PromotionsResponse.content."application/json": |
| 124 | +```diff |
| 125 | +- readonly data?: components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; |
| 126 | ++ readonly data?: components["schemas"]["SavedCouponPromotion"] | components["schemas"]["SavedAutomaticPromotion"]; |
| 127 | +``` |
| 128 | + |
| 129 | +components.parameters: |
| 130 | +```diff |
| 131 | ++ readonly Query: string; |
| 132 | +``` |
| 133 | + |
| 134 | +operations.getPromotions.parameters.query: |
| 135 | +```diff |
| 136 | ++ readonly query?: components["parameters"]["Query"]; |
| 137 | +``` |
| 138 | + |
| 139 | +operations.createPromotion.requestBody.content: |
| 140 | +```diff |
| 141 | +- readonly "application/json": components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; |
| 142 | ++ readonly "application/json": components["schemas"]["DraftCouponPromotion"] | components["schemas"]["DraftAutomaticPromotion"]; |
| 143 | +``` |
| 144 | + |
| 145 | +operations.updatePromotion.requestBody.content: |
| 146 | +```diff |
| 147 | +- readonly "application/json": components["schemas"]["PromotionCoupon"] | components["schemas"]["PromotionAutomatic"]; |
| 148 | ++ readonly "application/json": components["schemas"]["PatchCouponPromotion"] | components["schemas"]["PatchAutomaticPromotion"]; |
| 149 | +``` |
| 150 | + |
| 151 | +: |
| 152 | +```diff |
| 153 | ++ type WithRequired<T, K extends keyof T> = T & { |
| 154 | ++ [P in K]-?: T[P]; |
| 155 | ++ }; |
| 156 | +``` |
| 157 | + |
0 commit comments