yellowgrid-api-ts 3.2.132-dev.0 → 3.2.134-dev.0

package/.openapi-generator/FILES

@@ -153,6 +153,9 @@ docs/ProductSummaryDTO.md
 docs/ProductsApi.md
 docs/PromoCodesEntity.md
 docs/PromoItemsEntity.md
+docs/ProspectDTO.md
+docs/ProspectEntity.md
+docs/ProspectsApi.md
 docs/ProvisioningApi.md
 docs/ProvisioningModel.md
 docs/ProvisioningRequestEntity.md

package/README.md

@@ -213,6 +213,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
+*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
+*ProspectsApi* | [**getSetCallback**](docs/ProspectsApi.md#getsetcallback) | **GET** /accounts/prospects/{xero_id}/date | Set Call Back Date
 *ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
 *ProvisioningApi* | [**deleteDeleteFanvilGroup**](docs/ProvisioningApi.md#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS
 *ProvisioningApi* | [**getGetFanvilEncryptionKey**](docs/ProvisioningApi.md#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key
@@ -425,6 +429,8 @@ Class | Method | HTTP request | Description
  - [ProductSummaryDTO](docs/ProductSummaryDTO.md)
  - [PromoCodesEntity](docs/PromoCodesEntity.md)
  - [PromoItemsEntity](docs/PromoItemsEntity.md)
+ - [ProspectDTO](docs/ProspectDTO.md)
+ - [ProspectEntity](docs/ProspectEntity.md)
  - [ProvisioningModel](docs/ProvisioningModel.md)
  - [ProvisioningRequestEntity](docs/ProvisioningRequestEntity.md)
  - [PutAllocateItemsRequest](docs/PutAllocateItemsRequest.md)

package/api.ts

@@ -933,6 +933,7 @@ export const AuditLogEntityTypeEnum = {
     PopsPromoCodes: 'pops_promo_codes',
     PopsPromoItems: 'pops_promo_items',
     PopsProvisioning: 'pops_provisioning',
+    PopsProspectsV2: 'pops_prospects_v2',
     S3Buckets: 's3_buckets',
     PopsShipmentAddress: 'pops_shipment_address',
     PopsShipments: 'pops_shipments',
@@ -4635,6 +4636,103 @@ export interface PromoItemsEntity {
      */
     'bulkAdd'?: number;
 }
+/**
+ * Prospect
+ */
+export interface ProspectDTO {
+    /**
+     * Company Name
+     */
+    'companyName'?: string;
+    /**
+     * Telephone
+     */
+    'telephone'?: string | null;
+    /**
+     * Date Time
+     */
+    'lastOrderDate'?: string | null;
+    /**
+     * Date Time
+     */
+    'callbackDate'?: string | null;
+    /**
+     * Xero ID
+     */
+    'xeroId'?: string;
+    /**
+     * Removed From Prospects
+     */
+    'removed'?: boolean;
+    /**
+     * Status
+     */
+    'status'?: ProspectDTOStatusEnum;
+    /**
+     * Order Count
+     */
+    'orderCount'?: number;
+}
+
+export const ProspectDTOStatusEnum = {
+    NoCallBackSet: 'No Call Back Set',
+    CallBackDue: 'Call Back Due',
+    NoOrdersPlaced: 'No Orders Placed',
+    NoOrdersInTheLast4Months: 'No Orders In The Last 4 Months',
+    NoActionRequired: 'No Action Required'
+} as const;
+
+export type ProspectDTOStatusEnum = typeof ProspectDTOStatusEnum[keyof typeof ProspectDTOStatusEnum];
+
+/**
+ * ProspectEntity
+ */
+export interface ProspectEntity {
+    /**
+     * id
+     */
+    'id'?: number;
+    /**
+     * status
+     */
+    'status'?: number;
+    /**
+     * customerId
+     */
+    'customerId'?: number;
+    /**
+     * companyName
+     */
+    'companyName'?: string;
+    /**
+     * contactName
+     */
+    'contactName'?: string;
+    /**
+     * telephone
+     */
+    'telephone'?: string;
+    /**
+     * email
+     */
+    'email'?: string;
+    /**
+     * reason
+     */
+    'reason'?: string;
+    /**
+     * lastOrderDate
+     */
+    'lastOrderDate'?: string;
+    /**
+     * followUpDate
+     */
+    'followUpDate'?: string;
+    /**
+     * notes
+     */
+    'notes'?: string;
+}
 /**
  * Provisioning Group
  */
@@ -20916,6 +21014,324 @@ export const GetGetLegacyStockListFormatEnum = {
 export type GetGetLegacyStockListFormatEnum = typeof GetGetLegacyStockListFormatEnum[keyof typeof GetGetLegacyStockListFormatEnum];
 
 
+/**
+ * ProspectsApi - axios parameter creator
+ */
+export const ProspectsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get Prospect
+         * @summary Get Prospect
+         * @param {string} xeroId Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetProspect: async (xeroId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'xeroId' is not null or undefined
+            assertParamExists('getGetProspect', 'xeroId', xeroId)
+            const localVarPath = `/accounts/prospects/{xero_id}`
+                .replace(`{${"xero_id"}}`, encodeURIComponent(String(xeroId)));
+            // 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 Prospects
+         * @summary Get Prospects
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetProspects: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/accounts/prospects`;
+            // 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,
+            };
+        },
+        /**
+         * Remove From Prospect
+         * @summary Remove From Prospects
+         * @param {string} xeroId Xero ID
+         * @param {boolean} status Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoveFromProspects: async (xeroId: string, status: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'xeroId' is not null or undefined
+            assertParamExists('getRemoveFromProspects', 'xeroId', xeroId)
+            // verify required parameter 'status' is not null or undefined
+            assertParamExists('getRemoveFromProspects', 'status', status)
+            const localVarPath = `/accounts/prospects/{xero_id}/remove`
+                .replace(`{${"xero_id"}}`, encodeURIComponent(String(xeroId)));
+            // 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 (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+
+            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,
+            };
+        },
+        /**
+         * Set Call Back Date
+         * @summary Set Call Back Date
+         * @param {string} xeroId Xero ID
+         * @param {string} date Callback Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSetCallback: async (xeroId: string, date: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'xeroId' is not null or undefined
+            assertParamExists('getSetCallback', 'xeroId', xeroId)
+            // verify required parameter 'date' is not null or undefined
+            assertParamExists('getSetCallback', 'date', date)
+            const localVarPath = `/accounts/prospects/{xero_id}/date`
+                .replace(`{${"xero_id"}}`, encodeURIComponent(String(xeroId)));
+            // 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 (date !== undefined) {
+                localVarQueryParameter['date'] = date;
+            }
+
+            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,
+            };
+        },
+    }
+};
+
+/**
+ * ProspectsApi - functional programming interface
+ */
+export const ProspectsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ProspectsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get Prospect
+         * @summary Get Prospect
+         * @param {string} xeroId Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetProspect(xeroId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProspectDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetProspect(xeroId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProspectsApi.getGetProspect']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get Prospects
+         * @summary Get Prospects
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetProspects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProspectDTO>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetProspects(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProspectsApi.getGetProspects']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Remove From Prospect
+         * @summary Remove From Prospects
+         * @param {string} xeroId Xero ID
+         * @param {boolean} status Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getRemoveFromProspects(xeroId: string, status: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProspectDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getRemoveFromProspects(xeroId, status, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProspectsApi.getRemoveFromProspects']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Set Call Back Date
+         * @summary Set Call Back Date
+         * @param {string} xeroId Xero ID
+         * @param {string} date Callback Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSetCallback(xeroId: string, date: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProspectDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSetCallback(xeroId, date, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProspectsApi.getSetCallback']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ProspectsApi - factory interface
+ */
+export const ProspectsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ProspectsApiFp(configuration)
+    return {
+        /**
+         * Get Prospect
+         * @summary Get Prospect
+         * @param {string} xeroId Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetProspect(xeroId: string, options?: RawAxiosRequestConfig): AxiosPromise<ProspectDTO> {
+            return localVarFp.getGetProspect(xeroId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get Prospects
+         * @summary Get Prospects
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetProspects(options?: RawAxiosRequestConfig): AxiosPromise<Array<ProspectDTO>> {
+            return localVarFp.getGetProspects(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Remove From Prospect
+         * @summary Remove From Prospects
+         * @param {string} xeroId Xero ID
+         * @param {boolean} status Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRemoveFromProspects(xeroId: string, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ProspectDTO> {
+            return localVarFp.getRemoveFromProspects(xeroId, status, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Set Call Back Date
+         * @summary Set Call Back Date
+         * @param {string} xeroId Xero ID
+         * @param {string} date Callback Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSetCallback(xeroId: string, date: string, options?: RawAxiosRequestConfig): AxiosPromise<ProspectDTO> {
+            return localVarFp.getSetCallback(xeroId, date, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ProspectsApi - object-oriented interface
+ */
+export class ProspectsApi extends BaseAPI {
+    /**
+     * Get Prospect
+     * @summary Get Prospect
+     * @param {string} xeroId Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetProspect(xeroId: string, options?: RawAxiosRequestConfig) {
+        return ProspectsApiFp(this.configuration).getGetProspect(xeroId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get Prospects
+     * @summary Get Prospects
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetProspects(options?: RawAxiosRequestConfig) {
+        return ProspectsApiFp(this.configuration).getGetProspects(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Remove From Prospect
+     * @summary Remove From Prospects
+     * @param {string} xeroId Xero ID
+     * @param {boolean} status Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getRemoveFromProspects(xeroId: string, status: boolean, options?: RawAxiosRequestConfig) {
+        return ProspectsApiFp(this.configuration).getRemoveFromProspects(xeroId, status, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Set Call Back Date
+     * @summary Set Call Back Date
+     * @param {string} xeroId Xero ID
+     * @param {string} date Callback Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getSetCallback(xeroId: string, date: string, options?: RawAxiosRequestConfig) {
+        return ProspectsApiFp(this.configuration).getSetCallback(xeroId, date, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * ProvisioningApi - axios parameter creator
  */