@compassdigital/sdk.typescript 4.394.0 → 4.395.0

package/src/interface/discount.ts

@@ -3,6 +3,36 @@
 
 import { RequestQuery, BaseRequest } from './util';
 
+export interface DeleteDiscountResponseDTO {
+	success: boolean;
+}
+
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
+}
+
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	// user friendly error message
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	// additional error data
+	data: ErrorData;
+}
+
 export interface DiscountStatus {
 	live?: boolean;
 	publishedTo3rdParty?: boolean;
@@ -69,7 +99,7 @@ export interface DiscountChannelConfig {
 	agilysys: boolean;
 }
 
-export interface GetDiscountResponseDTO {
+export interface DiscountWithEntities {
 	// discount id
 	id: string;
 	// user id of discount creator
@@ -90,33 +120,11 @@ export interface GetDiscountResponseDTO {
 	channelConfig: DiscountChannelConfig;
 }
 
-export interface ErrorDisplayMessage {
-	// user message title
-	title: string;
-	// user message description
-	description: string;
-}
-
-export interface ErrorData {
-	// http status code
-	statusCode: number;
-	// http status text
-	statusText: string;
-	timestamp: string;
-	// user friendly error message
-	displayMessage: ErrorDisplayMessage;
-}
-
-export interface Error {
-	// business error code
-	code: number;
-	// business error description
-	message: string;
-	// additional error data
-	data: ErrorData;
+export interface GetAllDiscountsResponseDTO {
+	discounts: DiscountWithEntities[];
 }
 
-export interface DiscountDTO {
+export interface GetDiscountResponseDTO {
 	// discount id
 	id: string;
 	// user id of discount creator
@@ -125,6 +133,8 @@ export interface DiscountDTO {
 	updatedBy: string;
 	// What the discount applies to
 	appliesTo: 'order' | 'items';
+	sites?: string[];
+	brands?: string[];
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -135,11 +145,7 @@ export interface DiscountDTO {
 	channelConfig: DiscountChannelConfig;
 }
 
-export interface GetDiscountsResponseDTO {
-	discounts: DiscountDTO[];
-}
-
-export interface DiscountWithEntities {
+export interface DiscountDTO {
 	// discount id
 	id: string;
 	// user id of discount creator
@@ -156,33 +162,25 @@ export interface DiscountWithEntities {
 	meta?: DiscountMeta;
 	schedule?: DiscountSchedule;
 	channelConfig: DiscountChannelConfig;
-	sites?: string[];
-	brands?: string[];
-}
-
-export interface GetAllDiscountsResponseDTO {
-	discounts: DiscountWithEntities[];
 }
 
-export interface DiscountTaxonomy {
-	site?: string[];
-	brand?: string[];
+export interface GetDiscountsResponseDTO {
+	discounts: DiscountDTO[];
 }
 
-export interface PostDiscountRequestDTO {
+export interface PatchDiscountRequestDTO {
 	// What the discount applies to
-	appliesTo: 'order' | 'items';
-	createdBy: string;
-	name: string;
+	appliesTo?: 'order' | 'items';
+	updatedBy: string;
+	status?: DiscountStatus;
+	name?: string;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 	schedule?: DiscountSchedule;
-	channelConfig: DiscountChannelConfig;
-	taxonomy?: DiscountTaxonomy;
-	status?: DiscountStatus;
+	channelConfig?: DiscountChannelConfig;
 }
 
-export interface PostDiscountResponseDTO {
+export interface PatchDiscountResponseDTO {
 	// discount id
 	id: string;
 	// user id of discount creator
@@ -201,20 +199,25 @@ export interface PostDiscountResponseDTO {
 	channelConfig: DiscountChannelConfig;
 }
 
-export interface PutDiscountRequestDTO {
+export interface DiscountTaxonomy {
+	site?: string[];
+	brand?: string[];
+}
+
+export interface PostDiscountRequestDTO {
 	// What the discount applies to
 	appliesTo: 'order' | 'items';
-	updatedBy: string;
-	taxonomy?: DiscountTaxonomy;
-	status?: DiscountStatus;
+	createdBy: string;
 	name: string;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 	schedule?: DiscountSchedule;
 	channelConfig: DiscountChannelConfig;
+	taxonomy?: DiscountTaxonomy;
+	status?: DiscountStatus;
 }
 
-export interface PutDiscountResponseDTO {
+export interface PostDiscountResponseDTO {
 	// discount id
 	id: string;
 	// user id of discount creator
@@ -233,63 +236,28 @@ export interface PutDiscountResponseDTO {
 	channelConfig: DiscountChannelConfig;
 }
 
-export interface PutDiscountPublishRequestDTO {
-	// user id of most recent update
-	updatedBy: string;
-}
-
-export interface PutDiscountPublishResponseDTO {
-	// discount id
-	id: string;
-	// user id of discount creator
-	createdBy: string;
-	// user id of most recent update
-	updatedBy: string;
-	// What the discount applies to
-	appliesTo: 'order' | 'items';
-	is: DiscountIs;
-	meta: DiscountMeta;
-	schedule: DiscountSchedule;
-	channelConfig: DiscountChannelConfig;
-	createdAt: string;
-	updatedAt: string;
-	name: string;
-	status: DiscountStatus;
+export interface PostDiscountEventRequestDTO {
+	// Event type
+	type: 'OrderCreatedEvent' | 'ExternalRewardCreatedEvent' | 'ExternalRewardRedeemedEvent';
+	// Event version
+	version: string;
+	// Event source
+	source: string;
+	// Event payload
+	payload: Record<string, any>;
+	// Event timestamp epoch seconds
+	timestamp?: string;
+	// Event ID
+	id?: string;
 }
 
-export interface DeleteDiscountResponseDTO {
+export interface PostDiscountEventResponseDTO {
+	// Success indicator
 	success: boolean;
-}
-
-export interface PatchDiscountRequestDTO {
-	// What the discount applies to
-	appliesTo?: 'order' | 'items';
-	updatedBy: string;
-	status?: DiscountStatus;
-	name?: string;
-	is?: DiscountIs;
-	meta?: DiscountMeta;
-	schedule?: DiscountSchedule;
-	channelConfig?: DiscountChannelConfig;
-}
-
-export interface PatchDiscountResponseDTO {
-	// discount id
-	id: string;
-	// user id of discount creator
-	createdBy: string;
-	// user id of most recent update
-	updatedBy: string;
-	// What the discount applies to
-	appliesTo: 'order' | 'items';
-	createdAt: string;
-	updatedAt: string;
-	name: string;
-	status: DiscountStatus;
-	is?: DiscountIs;
-	meta?: DiscountMeta;
-	schedule?: DiscountSchedule;
-	channelConfig: DiscountChannelConfig;
+	// Optional message
+	message?: string;
+	// Event type
+	type?: string;
 }
 
 export interface PostRewardsBodyDTO {
@@ -371,30 +339,71 @@ export interface PostRewardsResponseDTO {
 	campaigns: CustomerRewardCampaignDTO[];
 }
 
-export interface PostDiscountEventRequestDTO {
-	// Event type
-	type: 'OrderCreatedEvent' | 'ExternalRewardCreatedEvent' | 'ExternalRewardRedeemedEvent';
-	// Event version
-	version: string;
-	// Event source
-	source: string;
-	// Event payload
-	payload: Record<string, any>;
-	// Event timestamp epoch seconds
-	timestamp?: string;
-	// Event ID
-	id?: string;
+export interface PutDiscountRequestDTO {
+	// What the discount applies to
+	appliesTo: 'order' | 'items';
+	updatedBy: string;
+	taxonomy?: DiscountTaxonomy;
+	status?: DiscountStatus;
+	name: string;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	schedule?: DiscountSchedule;
+	channelConfig: DiscountChannelConfig;
 }
 
-export interface PostDiscountEventResponseDTO {
-	// Success indicator
-	success: boolean;
-	// Optional message
-	message?: string;
-	// Event type
-	type?: string;
+export interface PutDiscountResponseDTO {
+	// discount id
+	id: string;
+	// user id of discount creator
+	createdBy: string;
+	// user id of most recent update
+	updatedBy: string;
+	// What the discount applies to
+	appliesTo: 'order' | 'items';
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	status: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	schedule?: DiscountSchedule;
+	channelConfig: DiscountChannelConfig;
+}
+
+export interface PutDiscountPublishRequestDTO {
+	// user id of most recent update
+	updatedBy: string;
+}
+
+export interface PutDiscountPublishResponseDTO {
+	// discount id
+	id: string;
+	// user id of discount creator
+	createdBy: string;
+	// user id of most recent update
+	updatedBy: string;
+	// What the discount applies to
+	appliesTo: 'order' | 'items';
+	is: DiscountIs;
+	meta: DiscountMeta;
+	schedule: DiscountSchedule;
+	channelConfig: DiscountChannelConfig;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	status: DiscountStatus;
 }
 
+// DELETE /discount/{id} - Delete a discount
+
+export interface DeleteDiscountPath {
+	// Discount id
+	id: string;
+}
+
+export type DeleteDiscountResponse = DeleteDiscountResponseDTO;
+
 // GET /discount/{id} - Get a discount
 
 export interface GetDiscountPath {
@@ -409,36 +418,36 @@ export interface GetDiscountQuery {
 
 export type GetDiscountResponse = GetDiscountResponseDTO;
 
-// PUT /discount/{id} - Update a discount
+// PATCH /discount/{id} - Patch a discount
 
-export interface PutDiscountPath {
+export interface PatchDiscountPath {
 	// Discount ID
 	id: string;
 }
 
-export type PutDiscountBody = PutDiscountRequestDTO;
+export type PatchDiscountBody = PatchDiscountRequestDTO;
 
-export type PutDiscountResponse = PutDiscountResponseDTO;
+export type PatchDiscountResponse = PatchDiscountResponseDTO;
 
-// DELETE /discount/{id} - Delete a discount
+// PUT /discount/{id} - Update a discount
 
-export interface DeleteDiscountPath {
-	// Discount id
+export interface PutDiscountPath {
+	// Discount ID
 	id: string;
 }
 
-export type DeleteDiscountResponse = DeleteDiscountResponseDTO;
+export type PutDiscountBody = PutDiscountRequestDTO;
 
-// PATCH /discount/{id} - Patch a discount
+export type PutDiscountResponse = PutDiscountResponseDTO;
 
-export interface PatchDiscountPath {
-	// Discount ID
-	id: string;
-}
+// GET /discount/all - Get all discounts
 
-export type PatchDiscountBody = PatchDiscountRequestDTO;
+export interface GetDiscountsAllQuery {
+	// Graphql query string
+	_query?: string;
+}
 
-export type PatchDiscountResponse = PatchDiscountResponseDTO;
+export type GetDiscountsAllResponse = GetAllDiscountsResponseDTO;
 
 // GET /discount - Get discounts by taxonomy
 
@@ -458,25 +467,11 @@ export type PostDiscountBody = PostDiscountRequestDTO;
 
 export type PostDiscountResponse = PostDiscountResponseDTO;
 
-// GET /discount/all - Get all discounts
-
-export interface GetDiscountsAllQuery {
-	// Graphql query string
-	_query?: string;
-}
-
-export type GetDiscountsAllResponse = GetAllDiscountsResponseDTO;
-
-// PUT /discount/{id}/publish - Publish a discount
-
-export interface PutDiscountPublishPath {
-	// Discount ID
-	id: string;
-}
+// POST /discount/event - Handle discount event
 
-export type PutDiscountPublishBody = PutDiscountPublishRequestDTO;
+export type PostDiscountEventBody = PostDiscountEventRequestDTO;
 
-export type PutDiscountPublishResponse = PutDiscountPublishResponseDTO;
+export type PostDiscountEventResponse = PostDiscountEventResponseDTO;
 
 // POST /discount/site/{id}/rewards - Get eligible rewards for a customer and site
 
@@ -494,8 +489,13 @@ export type PostRewardsBody = PostRewardsBodyDTO;
 
 export type PostRewardsResponse = PostRewardsResponseDTO;
 
-// POST /discount/event - Handle discount event
+// PUT /discount/{id}/publish - Publish a discount
 
-export type PostDiscountEventBody = PostDiscountEventRequestDTO;
+export interface PutDiscountPublishPath {
+	// Discount ID
+	id: string;
+}
 
-export type PostDiscountEventResponse = PostDiscountEventResponseDTO;
+export type PutDiscountPublishBody = PutDiscountPublishRequestDTO;
+
+export type PutDiscountPublishResponse = PutDiscountPublishResponseDTO;