@zenglobal/api-client 4.0.0 → 5.0.0

package/dist/client/types.gen.d.ts

@@ -3626,6 +3626,90 @@ export type OfferDeleteResult = {
     result: number;
     errormessage: string;
 };
+export type OfferDetailAmount = {
+    type: string;
+    value: number;
+};
+export type OfferDetailBirthday = {
+    enabled: boolean;
+    delta_days?: number;
+    direction?: string;
+};
+export type OfferDetailConditions = {
+    active_on?: string;
+    expires_on?: string;
+    minimum_trigger_amount: number;
+    maximum_trigger_amount: number;
+    limits: OfferDetailLimits;
+    time_of_day?: OfferDetailTimeOfDay;
+    birthday: OfferDetailBirthday;
+    new_member_window: OfferDetailNewMemberWindow;
+    trigger_days_valid_after?: number;
+    filters: OfferDetailFilters;
+};
+export type OfferDetailDiscountItem = {
+    number?: string;
+    type?: string;
+};
+export type OfferDetailEffect = {
+    type: string;
+    amount: OfferDetailAmount;
+    apply_to: string;
+    apply_upto_quantity: number;
+    apply_to_items: Array<string>;
+    per_item: boolean;
+    points_multiplier: number;
+    discount_item: OfferDetailDiscountItem;
+    department: number;
+};
+export type OfferDetailFilters = {
+    site?: OfferFilterValue;
+    location?: OfferFilterValue;
+    location_type?: OfferFilterValue;
+    region?: OfferFilterValue;
+    state?: OfferFilterValue;
+    day_of_week?: OfferFilterValue;
+};
+export type OfferDetailLimits = {
+    number_allowed_per_card?: number;
+    number_allowed_per_site?: number;
+    every?: string;
+};
+export type OfferDetailNewMemberWindow = {
+    start?: string;
+    end?: string;
+};
+/**
+ * Full offer detail returned by GET /v1/offers/{id}
+ */
+export type OfferDetailResponse = {
+    id: number;
+    description?: string;
+    enabled: boolean;
+    reference?: string;
+    comment?: string;
+    loyalty_only: boolean;
+    auto_applied: boolean;
+    image_url?: string;
+    updated_at?: string;
+    conditions: OfferDetailConditions;
+    effect: OfferDetailEffect;
+    targeting: OfferDetailTargeting;
+    linked_to: boolean;
+    card_active: boolean;
+    card_complete: boolean;
+    event_id?: number;
+};
+export type OfferDetailTargeting = {
+    card_type_flag?: string;
+    loyalty_card_types: Array<number | null>;
+    group_flag?: string;
+    groups: Array<number | null>;
+};
+export type OfferDetailTimeOfDay = {
+    start_hour: string;
+    end_hour: string;
+};
 export type OfferEffect = {
     /**
      * The type and amount of discount offered with the offer
@@ -3642,6 +3726,10 @@ export type OfferEffect = {
      */
     apply_to_items?: Array<string>;
 };
+export type OfferFilterValue = {
+    operator: string;
+    values: Array<number>;
+};
 /**
  * The limits imposed upon the offer
  */
@@ -3755,6 +3843,19 @@ export type OfferResult = {
      */
     id: string;
 };
+export type OfferSearchResponse = {
+    total_records: number;
+    limit: number;
+    results: Array<OfferSearchResult>;
+};
+export type OfferSearchResult = {
+    id: number;
+    description?: string;
+    reference?: string;
+    enabled: boolean;
+    active_on?: string;
+    expires_on?: string;
+};
 /**
  * The type of offer discount
  * * `fixed_per_item` - Each item in the apply to list should be set to this dollar amount
@@ -9515,6 +9616,72 @@ export type OfferUpdateResponses = {
     200: OfferResult;
 };
 export type OfferUpdateResponse = OfferUpdateResponses[keyof OfferUpdateResponses];
+export type OffersSearchData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Search term to match against reference and/or description
+         */
+        q: string;
+        /**
+         * Constrain search to a specific field
+         */
+        field?: 'reference' | 'description';
+        /**
+         * Maximum number of results to return (default: 50)
+         */
+        limit?: number;
+    };
+    url: '/v1/offers/search';
+};
+export type OffersSearchErrors = {
+    /**
+     * The server could not understand the request due to invalid syntax.
+     */
+    400: ValidationError;
+    /**
+     * Access is unauthorized.
+     */
+    401: InvalidAccessKeyError;
+};
+export type OffersSearchError = OffersSearchErrors[keyof OffersSearchErrors];
+export type OffersSearchResponses = {
+    /**
+     * The request has succeeded.
+     */
+    200: OfferSearchResponse;
+};
+export type OffersSearchResponse = OffersSearchResponses[keyof OffersSearchResponses];
+export type OffersGetByIdData = {
+    body?: never;
+    path: {
+        /**
+         * Unique identifier of the offer
+         */
+        id: number;
+    };
+    query?: never;
+    url: '/v1/offers/{id}';
+};
+export type OffersGetByIdErrors = {
+    /**
+     * The server could not understand the request due to invalid syntax.
+     */
+    400: ValidationError;
+    /**
+     * Access is unauthorized.
+     */
+    401: InvalidAccessKeyError;
+};
+export type OffersGetByIdError = OffersGetByIdErrors[keyof OffersGetByIdErrors];
+export type OffersGetByIdResponses = {
+    /**
+     * The request has succeeded.
+     */
+    200: OfferDetailResponse;
+};
+export type OffersGetByIdResponse = OffersGetByIdResponses[keyof OffersGetByIdResponses];
 export type OrderDeleteOrderData = {
     body: OrderDeleteRequest;
     path?: never;