yellowgrid-api-ts 3.2.239 → 3.2.241

package/dist/api.d.ts

@@ -1020,6 +1020,30 @@ export interface AuthCodeResponseModel {
      */
     'redirect_uri'?: string | null;
 }
+/**
+ * Graph Axis Data
+ */
+export interface AxisDataDTO {
+    /**
+     * Type
+     */
+    'type'?: AxisDataDTOTypeEnum;
+    /**
+     * Data
+     */
+    'data'?: Array<string> | null;
+    /**
+     * Name
+     */
+    'name'?: string | null;
+}
+export declare const AxisDataDTOTypeEnum: {
+    readonly Value: "value";
+    readonly Category: "category";
+    readonly Time: "time";
+    readonly Log: "log";
+};
+export type AxisDataDTOTypeEnum = typeof AxisDataDTOTypeEnum[keyof typeof AxisDataDTOTypeEnum];
 /**
  * Basic Order Item
  */
@@ -1844,6 +1868,35 @@ export interface CrmNoteModel {
      */
     'callId'?: number;
 }
+/**
+ * Customer Coordinates
+ */
+export interface CustomerCoordinatesDTO {
+    /**
+     * ID
+     */
+    'id'?: string;
+    /**
+     * Company
+     */
+    'company'?: string;
+    /**
+     * 3CX Reseller ID
+     */
+    'resellerId'?: string | null;
+    /**
+     * Post Code
+     */
+    'postCode'?: string;
+    /**
+     * Latitude
+     */
+    'latitude'?: string;
+    /**
+     * Longitude
+     */
+    'longitude'?: string;
+}
 /**
  * SIP Trunk Customer
  */
@@ -2600,6 +2653,73 @@ export interface GetGetPrice200Response {
 export interface GetGetRecording200Response {
     'recordingData'?: string;
 }
+/**
+ * Graph
+ */
+export interface GraphDTO {
+    /**
+     * Title
+     */
+    'title'?: string;
+    /**
+     * X Axis
+     */
+    'xAxis'?: Array<AxisDataDTO>;
+    /**
+     * Y Axis
+     */
+    'yAxis'?: Array<AxisDataDTO>;
+    /**
+     * Legend
+     */
+    'legend'?: Array<string>;
+    /**
+     * Series
+     */
+    'series'?: Array<SeriesDTO>;
+    /**
+     * Currency
+     */
+    'currency'?: GraphDTOCurrencyEnum | null;
+    /**
+     * Locale
+     */
+    'locale'?: string;
+}
+export declare const GraphDTOCurrencyEnum: {
+    readonly Eur: "EUR";
+    readonly Usd: "USD";
+    readonly Jpy: "JPY";
+    readonly Bgn: "BGN";
+    readonly Czk: "CZK";
+    readonly Dkk: "DKK";
+    readonly Gbp: "GBP";
+    readonly Huf: "HUF";
+    readonly Pln: "PLN";
+    readonly Ron: "RON";
+    readonly Sek: "SEK";
+    readonly Chf: "CHF";
+    readonly Isk: "ISK";
+    readonly Nok: "NOK";
+    readonly Try: "TRY";
+    readonly Aud: "AUD";
+    readonly Brl: "BRL";
+    readonly Cad: "CAD";
+    readonly Cny: "CNY";
+    readonly Hkd: "HKD";
+    readonly Idr: "IDR";
+    readonly Ils: "ILS";
+    readonly Inr: "INR";
+    readonly Krw: "KRW";
+    readonly Mxn: "MXN";
+    readonly Myr: "MYR";
+    readonly Nzd: "NZD";
+    readonly Php: "PHP";
+    readonly Sgd: "SGD";
+    readonly Thb: "THB";
+    readonly Zar: "ZAR";
+};
+export type GraphDTOCurrencyEnum = typeof GraphDTOCurrencyEnum[keyof typeof GraphDTOCurrencyEnum];
 /**
  * Change Response
  */
@@ -4706,6 +4826,10 @@ export interface PostAddOrderNoteRequest {
 export interface PostAddWebhook200Response {
     'url'?: string;
 }
+/**
+ * @type PostGenerateReport200Response
+ */
+export type PostGenerateReport200Response = GraphDTO | TableDTO;
 export interface PostGetClientCredentialsRequest {
     /**
      * OAuth 2.0 scopes
@@ -5290,6 +5414,65 @@ export interface RemoteStorageDTO {
      */
     'region'?: string;
 }
+/**
+ * Report Request
+ */
+export interface ReportRequestDTO {
+    /**
+     * Report
+     */
+    'report'?: ReportRequestDTOReportEnum;
+    /**
+     * Start
+     */
+    'start'?: string | null;
+    /**
+     * End
+     */
+    'end'?: string | null;
+    /**
+     * Month
+     */
+    'month'?: number | null;
+    /**
+     * Year
+     */
+    'year'?: number | null;
+    /**
+     * SKU
+     */
+    'sku'?: string | null;
+    /**
+     * Price
+     */
+    'price'?: number | null;
+    /**
+     * Recipients
+     */
+    'recipients'?: Array<string> | null;
+    /**
+     * Graph Type
+     */
+    'graphType'?: ReportRequestDTOGraphTypeEnum | null;
+}
+export declare const ReportRequestDTOReportEnum: {
+    readonly _1: "1";
+    readonly _2: "2";
+    readonly _3: "3";
+    readonly _4: "4";
+    readonly _5: "5";
+    readonly _6: "6";
+    readonly _7: "7";
+    readonly _8: "8";
+    readonly _9: "9";
+    readonly _10: "10";
+};
+export type ReportRequestDTOReportEnum = typeof ReportRequestDTOReportEnum[keyof typeof ReportRequestDTOReportEnum];
+export declare const ReportRequestDTOGraphTypeEnum: {
+    readonly StackedArea: "stacked-area";
+    readonly Table: "table";
+};
+export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
 /**
  * Resource Not Ready
  */
@@ -5420,6 +5603,31 @@ export interface ScopeModel {
      */
     'description'?: string;
 }
+/**
+ * Graph Series Data
+ */
+export interface SeriesDTO {
+    /**
+     * Name
+     */
+    'name'?: string;
+    /**
+     * Type
+     */
+    'type'?: SeriesDTOTypeEnum;
+    /**
+     * Stack
+     */
+    'stack'?: string | null;
+    /**
+     * Data
+     */
+    'data'?: Array<string>;
+}
+export declare const SeriesDTOTypeEnum: {
+    readonly Line: "line";
+};
+export type SeriesDTOTypeEnum = typeof SeriesDTOTypeEnum[keyof typeof SeriesDTOTypeEnum];
 /**
  * Service Health DTO
  */
@@ -7242,6 +7450,29 @@ export interface SupportTicketModel {
      */
     'conversations'?: Array<ConversationModel>;
 }
+/**
+ * Table
+ */
+export interface TableDTO {
+    /**
+     * Title
+     */
+    'title'?: string;
+    'headers'?: TableRowDTO;
+    /**
+     * Rows
+     */
+    'rows'?: Array<TableRowDTO>;
+}
+/**
+ * Table Data
+ */
+export interface TableDataDTO {
+    /**
+     * Value
+     */
+    'value'?: string;
+}
 /**
  * TableAttribsEntity
  */
@@ -7279,6 +7510,15 @@ export interface TableHistoryEntity {
      */
     'page'?: number;
 }
+/**
+ * Table Row
+ */
+export interface TableRowDTO {
+    /**
+     * Table Data
+     */
+    'data'?: Array<TableDataDTO>;
+}
 /**
  * 3CX Wizard Restore From Backup
  */
@@ -8934,6 +9174,12 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetCustomerKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -9310,6 +9556,12 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxKeySummaryDTO>>>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerCoordinatesDTO>>>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -9686,6 +9938,12 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerCoordinatesDTO>>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -10062,6 +10320,12 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxKeySummaryDTO[], any, {}>>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerCoordinatesDTO[], any, {}>>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -16440,6 +16704,14 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getGetStockReport: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Generate Reports
+     * @summary Generate Reports
+     * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGenerateReport: (reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ReportsApi - functional programming interface
@@ -16451,6 +16723,14 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetStockReport(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StockReportModel>>;
+    /**
+     * Generate Reports
+     * @summary Generate Reports
+     * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostGenerateReport200Response>>;
 };
 /**
  * ReportsApi - factory interface
@@ -16462,6 +16742,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getGetStockReport(options?: RawAxiosRequestConfig): AxiosPromise<StockReportModel>;
+    /**
+     * Generate Reports
+     * @summary Generate Reports
+     * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<PostGenerateReport200Response>;
 };
 /**
  * ReportsApi - object-oriented interface
@@ -16473,6 +16761,14 @@ export declare class ReportsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetStockReport(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StockReportModel, any, {}>>;
+    /**
+     * Generate Reports
+     * @summary Generate Reports
+     * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostGenerateReport200Response, any, {}>>;
 }
 /**
  * SIPTrunksApi - axios parameter creator