yellowgrid-api-ts 3.2.267 → 3.2.273

package/dist/api.d.ts

@@ -250,6 +250,10 @@ export interface AccountDetailedSummaryDTO {
      * Balance (£)
      */
     'balance'?: number | null;
+    /**
+     * First Order
+     */
+    'firstOrder'?: boolean;
 }
 /**
  * Account Finance DTO
@@ -5545,7 +5549,7 @@ export interface PromoCodesEntity {
     /**
      * id
      */
-    'id'?: number;
+    'id'?: number | null;
     /**
      * code
      */
@@ -5554,18 +5558,14 @@ export interface PromoCodesEntity {
      * description
      */
     'description'?: string;
-    /**
-     * banner
-     */
-    'banner'?: string;
     /**
      * start
      */
-    'start'?: string;
+    'startDate'?: string | null;
     /**
      * expiry
      */
-    'expiry'?: string;
+    'endDate'?: string | null;
     /**
      * customerLimit
      */
@@ -5577,19 +5577,60 @@ export interface PromoCodesEntity {
     /**
      * orderRestrictions
      */
-    'orderRestrictions'?: string;
+    'orderRestrictions'?: Array<string>;
     /**
      * includeDistribution
      */
-    'includeDistribution'?: number;
+    'includeDistribution'?: boolean;
     /**
      * distributionOnly
      */
-    'distributionOnly'?: number;
+    'distributionOnly'?: boolean;
+    /**
+     * nfr
+     */
+    'nfr'?: boolean;
     /**
      * note
      */
-    'note'?: string;
+    'note'?: string | null;
+}
+/**
+ * Promo Item
+ */
+export interface PromoItemModel {
+    /**
+     * id
+     */
+    'id'?: number;
+    /**
+     * promoId
+     */
+    'promoId'?: number;
+    /**
+     * price
+     */
+    'price'?: number;
+    /**
+     * discount
+     */
+    'discount'?: number;
+    /**
+     * sku
+     */
+    'sku'?: string;
+    /**
+     * quantity
+     */
+    'quantity'?: number;
+    /**
+     * bulkQuantity
+     */
+    'bulkQuantity'?: number;
+    /**
+     * bulkAdd
+     */
+    'bulkAdd'?: number;
 }
 /**
  * PromoItemsEntity
@@ -5628,6 +5669,113 @@ export interface PromoItemsEntity {
      */
     'bulkAdd'?: number;
 }
+/**
+ * Promotion
+ */
+export interface PromoModel {
+    /**
+     * id
+     */
+    'id'?: number | null;
+    /**
+     * code
+     */
+    'code'?: string;
+    /**
+     * description
+     */
+    'description'?: string;
+    /**
+     * start
+     */
+    'startDate'?: string | null;
+    /**
+     * expiry
+     */
+    'endDate'?: string | null;
+    /**
+     * customerLimit
+     */
+    'customerLimit'?: number;
+    /**
+     * globalLimit
+     */
+    'globalLimit'?: number;
+    /**
+     * orderRestrictions
+     */
+    'orderRestrictions'?: Array<string>;
+    /**
+     * includeDistribution
+     */
+    'includeDistribution'?: boolean;
+    /**
+     * distributionOnly
+     */
+    'distributionOnly'?: boolean;
+    /**
+     * nfr
+     */
+    'nfr'?: boolean;
+    /**
+     * note
+     */
+    'note'?: string | null;
+    /**
+     * Items
+     */
+    'items'?: Array<PromoItemModel>;
+}
+/**
+ * Promotions
+ */
+export interface PromoSummariesModel {
+    /**
+     * Results
+     */
+    'results'?: Array<PromoSummaryDTO>;
+    /**
+     * Page
+     */
+    'page'?: number;
+    /**
+     * Per Page
+     */
+    'perPage'?: number;
+    /**
+     * Total Results
+     */
+    'totalResults'?: number;
+}
+/**
+ * Promo Summary
+ */
+export interface PromoSummaryDTO {
+    /**
+     * ID
+     */
+    'id'?: number | null;
+    /**
+     * Description
+     */
+    'description'?: string;
+    /**
+     * Promo Code
+     */
+    'code'?: string;
+    /**
+     * Start Date
+     */
+    'startDate'?: string | null;
+    /**
+     * End Date
+     */
+    'endDate'?: string | null;
+    /**
+     * Orders
+     */
+    'orders'?: number;
+}
 /**
  * Prospect
  */
@@ -18730,6 +18878,154 @@ export declare const GetGetLegacyStockListFormatEnum: {
     readonly Csv: "CSV";
 };
 export type GetGetLegacyStockListFormatEnum = typeof GetGetLegacyStockListFormatEnum[keyof typeof GetGetLegacyStockListFormatEnum];
+/**
+ * PromotionsApi - axios parameter creator
+ */
+export declare const PromotionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get a promotion
+     * @param {number} id Promo ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromo: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Promos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {boolean} [expired] Expired
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromos: (pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a promotion
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetPromos: (promoModel?: PromoModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a promotion
+     * @param {number} id Promo ID
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetPromo: (id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PromotionsApi - functional programming interface
+ */
+export declare const PromotionsApiFp: (configuration?: Configuration) => {
+    /**
+     * Get a promotion
+     * @param {number} id Promo ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromo(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>>;
+    /**
+     * Get Promos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {boolean} [expired] Expired
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoSummariesModel>>;
+    /**
+     * Create a promotion
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>>;
+    /**
+     * Update a promotion
+     * @param {number} id Promo ID
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>>;
+};
+/**
+ * PromotionsApi - factory interface
+ */
+export declare const PromotionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get a promotion
+     * @param {number} id Promo ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromo(id: number, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel>;
+    /**
+     * Get Promos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {boolean} [expired] Expired
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PromoSummariesModel>;
+    /**
+     * Create a promotion
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel>;
+    /**
+     * Update a promotion
+     * @param {number} id Promo ID
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel>;
+};
+/**
+ * PromotionsApi - object-oriented interface
+ */
+export declare class PromotionsApi extends BaseAPI {
+    /**
+     * Get a promotion
+     * @param {number} id Promo ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromo(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoModel, any, {}>>;
+    /**
+     * Get Promos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {boolean} [expired] Expired
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoSummariesModel, any, {}>>;
+    /**
+     * Create a promotion
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoModel, any, {}>>;
+    /**
+     * Update a promotion
+     * @param {number} id Promo ID
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoModel, any, {}>>;
+}
 /**
  * ProspectsApi - axios parameter creator
  */