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

package/dist/api.d.ts

@@ -918,6 +918,7 @@ export declare const AuditLogEntityTypeEnum: {
     readonly PopsPromoCodes: "pops_promo_codes";
     readonly PopsPromoItems: "pops_promo_items";
     readonly PopsProvisioning: "pops_provisioning";
+    readonly PopsProspectsV2: "pops_prospects_v2";
     readonly S3Buckets: "s3_buckets";
     readonly PopsShipmentAddress: "pops_shipment_address";
     readonly PopsShipments: "pops_shipments";
@@ -4593,6 +4594,100 @@ 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 declare const ProspectDTOStatusEnum: {
+    readonly NoCallBackSet: "No Call Back Set";
+    readonly CallBackDue: "Call Back Due";
+    readonly NoOrdersPlaced: "No Orders Placed";
+    readonly NoOrdersInTheLast4Months: "No Orders In The Last 4 Months";
+    readonly NoActionRequired: "No Action Required";
+};
+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
  */
@@ -14193,6 +14288,158 @@ export declare const GetGetLegacyStockListFormatEnum: {
     readonly Csv: "CSV";
 };
 export type GetGetLegacyStockListFormatEnum = typeof GetGetLegacyStockListFormatEnum[keyof typeof GetGetLegacyStockListFormatEnum];
+/**
+ * ProspectsApi - axios parameter creator
+ */
+export declare const ProspectsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get Prospect
+     * @summary Get Prospect
+     * @param {string} xeroId Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspect: (xeroId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Prospects
+     * @summary Get Prospects
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+};
+/**
+ * ProspectsApi - functional programming interface
+ */
+export declare const ProspectsApiFp: (configuration?: Configuration) => {
+    /**
+     * Get Prospect
+     * @summary Get Prospect
+     * @param {string} xeroId Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspect(xeroId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProspectDTO>>;
+    /**
+     * Get Prospects
+     * @summary Get Prospects
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProspectDTO>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProspectDTO>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProspectDTO>>;
+};
+/**
+ * ProspectsApi - factory interface
+ */
+export declare const ProspectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * Get Prospects
+     * @summary Get Prospects
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspects(options?: RawAxiosRequestConfig): AxiosPromise<Array<ProspectDTO>>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * ProspectsApi - object-oriented interface
+ */
+export declare class ProspectsApi extends BaseAPI {
+    /**
+     * Get Prospect
+     * @summary Get Prospect
+     * @param {string} xeroId Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspect(xeroId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProspectDTO, any, {}>>;
+    /**
+     * Get Prospects
+     * @summary Get Prospects
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetProspects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProspectDTO[], any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ProspectDTO, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ProspectDTO, any, {}>>;
+}
 /**
  * ProvisioningApi - axios parameter creator
  */