yellowgrid-api-ts 3.2.267 → 3.2.273

package/.openapi-generator/FILES

@@ -211,7 +211,12 @@ docs/ProductSerialInfoModel.md
 docs/ProductSummaryDTO.md
 docs/ProductsApi.md
 docs/PromoCodesEntity.md
+docs/PromoItemModel.md
 docs/PromoItemsEntity.md
+docs/PromoModel.md
+docs/PromoSummariesModel.md
+docs/PromoSummaryDTO.md
+docs/PromotionsApi.md
 docs/ProspectDTO.md
 docs/ProspectEntity.md
 docs/ProspectsApi.md

package/README.md

@@ -307,6 +307,10 @@ Class | Method | HTTP request | Description
 *ProductsApi* | [**patchAddQuantityToStock**](docs/ProductsApi.md#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock
 *ProductsApi* | [**postGetProduct**](docs/ProductsApi.md#postgetproduct) | **POST** /products/{sku} | Get Product
 *ProductsApi* | [**postGetProductForCustomer**](docs/ProductsApi.md#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer
+*PromotionsApi* | [**getGetPromo**](docs/PromotionsApi.md#getgetpromo) | **GET** /marketing/promos/{id} | 
+*PromotionsApi* | [**getGetPromos**](docs/PromotionsApi.md#getgetpromos) | **GET** /marketing/promos | 
+*PromotionsApi* | [**postGetPromos**](docs/PromotionsApi.md#postgetpromos) | **POST** /marketing/promos | 
+*PromotionsApi* | [**putGetPromo**](docs/PromotionsApi.md#putgetpromo) | **PUT** /marketing/promos/{id} | 
 *ProspectsApi* | [**getGetProspect**](docs/ProspectsApi.md#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect
 *ProspectsApi* | [**getGetProspects**](docs/ProspectsApi.md#getgetprospects) | **GET** /accounts/prospects | Get Prospects
 *ProspectsApi* | [**getRemoveFromProspects**](docs/ProspectsApi.md#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects
@@ -587,7 +591,11 @@ Class | Method | HTTP request | Description
  - [ProductSerialInfoModel](docs/ProductSerialInfoModel.md)
  - [ProductSummaryDTO](docs/ProductSummaryDTO.md)
  - [PromoCodesEntity](docs/PromoCodesEntity.md)
+ - [PromoItemModel](docs/PromoItemModel.md)
  - [PromoItemsEntity](docs/PromoItemsEntity.md)
+ - [PromoModel](docs/PromoModel.md)
+ - [PromoSummariesModel](docs/PromoSummariesModel.md)
+ - [PromoSummaryDTO](docs/PromoSummaryDTO.md)
  - [ProspectDTO](docs/ProspectDTO.md)
  - [ProspectEntity](docs/ProspectEntity.md)
  - [ProvisioningModel](docs/ProvisioningModel.md)

package/api.ts

@@ -260,6 +260,10 @@ export interface AccountDetailedSummaryDTO {
      * Balance (£)
      */
     'balance'?: number | null;
+    /**
+     * First Order
+     */
+    'firstOrder'?: boolean;
 }
 /**
  * Account Finance DTO
@@ -5620,7 +5624,7 @@ export interface PromoCodesEntity {
     /**
      * id
      */
-    'id'?: number;
+    'id'?: number | null;
     /**
      * code
      */
@@ -5629,18 +5633,14 @@ export interface PromoCodesEntity {
      * description
      */
     'description'?: string;
-    /**
-     * banner
-     */
-    'banner'?: string;
     /**
      * start
      */
-    'start'?: string;
+    'startDate'?: string | null;
     /**
      * expiry
      */
-    'expiry'?: string;
+    'endDate'?: string | null;
     /**
      * customerLimit
      */
@@ -5652,19 +5652,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
@@ -5703,6 +5744,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
  */
@@ -29090,6 +29238,325 @@ export const GetGetLegacyStockListFormatEnum = {
 export type GetGetLegacyStockListFormatEnum = typeof GetGetLegacyStockListFormatEnum[keyof typeof GetGetLegacyStockListFormatEnum];
 
 
+/**
+ * PromotionsApi - axios parameter creator
+ */
+export const PromotionsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get a promotion
+         * @param {number} id Promo ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetPromo: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetPromo', 'id', id)
+            const localVarPath = `/marketing/promos/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (pageSize?: number, page?: number, search?: string, expired?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/marketing/promos`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (expired !== undefined) {
+                localVarQueryParameter['expired'] = expired;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Create a promotion
+         * @param {PromoModel} [promoModel] Promotion
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetPromos: async (promoModel?: PromoModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/marketing/promos`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(promoModel, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Update a promotion
+         * @param {number} id Promo ID
+         * @param {PromoModel} [promoModel] Promotion
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putGetPromo: async (id: number, promoModel?: PromoModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('putGetPromo', 'id', id)
+            const localVarPath = `/marketing/promos/{id}`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(promoModel, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * PromotionsApi - functional programming interface
+ */
+export const PromotionsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PromotionsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get a promotion
+         * @param {number} id Promo ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetPromo(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetPromo(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PromotionsApi.getGetPromo']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoSummariesModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetPromos(pageSize, page, search, expired, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PromotionsApi.getGetPromos']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Create a promotion
+         * @param {PromoModel} [promoModel] Promotion
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetPromos(promoModel, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PromotionsApi.postGetPromos']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Update a promotion
+         * @param {number} id Promo ID
+         * @param {PromoModel} [promoModel] Promotion
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.putGetPromo(id, promoModel, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PromotionsApi.putGetPromo']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * PromotionsApi - factory interface
+ */
+export const PromotionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PromotionsApiFp(configuration)
+    return {
+        /**
+         * Get a promotion
+         * @param {number} id Promo ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetPromo(id: number, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel> {
+            return localVarFp.getGetPromo(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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> {
+            return localVarFp.getGetPromos(pageSize, page, search, expired, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Create a promotion
+         * @param {PromoModel} [promoModel] Promotion
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig): AxiosPromise<PromoModel> {
+            return localVarFp.postGetPromos(promoModel, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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> {
+            return localVarFp.putGetPromo(id, promoModel, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * PromotionsApi - object-oriented interface
+ */
+export class PromotionsApi extends BaseAPI {
+    /**
+     * Get a promotion
+     * @param {number} id Promo ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetPromo(id: number, options?: RawAxiosRequestConfig) {
+        return PromotionsApiFp(this.configuration).getGetPromo(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public getGetPromos(pageSize?: number, page?: number, search?: string, expired?: boolean, options?: RawAxiosRequestConfig) {
+        return PromotionsApiFp(this.configuration).getGetPromos(pageSize, page, search, expired, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Create a promotion
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postGetPromos(promoModel?: PromoModel, options?: RawAxiosRequestConfig) {
+        return PromotionsApiFp(this.configuration).postGetPromos(promoModel, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Update a promotion
+     * @param {number} id Promo ID
+     * @param {PromoModel} [promoModel] Promotion
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public putGetPromo(id: number, promoModel?: PromoModel, options?: RawAxiosRequestConfig) {
+        return PromotionsApiFp(this.configuration).putGetPromo(id, promoModel, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * ProspectsApi - axios parameter creator
  */