yellowgrid-api-ts 3.2.239 → 3.2.240

package/.openapi-generator/FILES

@@ -31,6 +31,7 @@ docs/AttachmentModel.md
 docs/AttributeSetEnum.md
 docs/AuditLogEntity.md
 docs/AuthCodeResponseModel.md
+docs/AxisDataDTO.md
 docs/BasicItemDTO.md
 docs/BasicProductDTO.md
 docs/BatchDTO.md
@@ -95,6 +96,7 @@ docs/GenericFileModel.md
 docs/GetCheckMacExists200Response.md
 docs/GetGetPrice200Response.md
 docs/GetGetRecording200Response.md
+docs/GraphDTO.md
 docs/HostingChangeResponseModel.md
 docs/HostingRegionDTO.md
 docs/InstallationDetailsDTO.md
@@ -158,6 +160,7 @@ docs/PortalAccountModel.md
 docs/PortalLoginModel.md
 docs/PostAddOrderNoteRequest.md
 docs/PostAddWebhook200Response.md
+docs/PostGenerateReport200Response.md
 docs/PostGetClientCredentialsRequest.md
 docs/PostGetProductForCustomerRequest.md
 docs/PostSendWelcomeEmailRequest.md
@@ -186,6 +189,7 @@ docs/PutTransferConnectionRequest.md
 docs/RecordingBackupAzureModel.md
 docs/RecordingsBackupInfoDTO.md
 docs/RemoteStorageDTO.md
+docs/ReportRequestDTO.md
 docs/ReportsApi.md
 docs/ResourceNotReadyException.md
 docs/RootAccessModel.md
@@ -195,6 +199,7 @@ docs/SMSApi.md
 docs/SbcDTO.md
 docs/ScannedItemModel.md
 docs/ScopeModel.md
+docs/SeriesDTO.md
 docs/ServiceHealthDTO.md
 docs/ServiceStatusDTO.md
 docs/ServicesApi.md
@@ -260,7 +265,10 @@ docs/SupplierProductResultsModel.md
 docs/SuppliersApi.md
 docs/SupportTicketModel.md
 docs/SystemApi.md
+docs/TableDTO.md
+docs/TableDataDTO.md
 docs/TableHistoryEntity.md
+docs/TableRowDTO.md
 docs/TcxBackupEntity.md
 docs/TcxBackupModel.md
 docs/TcxBillingEntity.md

package/README.md

@@ -256,6 +256,7 @@ Class | Method | HTTP request | Description
 *ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
 *ProvisioningApi* | [**postCreateMac**](docs/ProvisioningApi.md#postcreatemac) | **POST** /admin/provisioning/fanvil/macs | 
 *ReportsApi* | [**getGetStockReport**](docs/ReportsApi.md#getgetstockreport) | **GET** /reports/stock | 
+*ReportsApi* | [**postGenerateReport**](docs/ReportsApi.md#postgeneratereport) | **POST** /reports | Generate Reports
 *SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
 *SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
 *SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
@@ -354,6 +355,7 @@ Class | Method | HTTP request | Description
  - [AttributeSetEnum](docs/AttributeSetEnum.md)
  - [AuditLogEntity](docs/AuditLogEntity.md)
  - [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
+ - [AxisDataDTO](docs/AxisDataDTO.md)
  - [BasicItemDTO](docs/BasicItemDTO.md)
  - [BasicProductDTO](docs/BasicProductDTO.md)
  - [BatchDTO](docs/BatchDTO.md)
@@ -411,6 +413,7 @@ Class | Method | HTTP request | Description
  - [GetCheckMacExists200Response](docs/GetCheckMacExists200Response.md)
  - [GetGetPrice200Response](docs/GetGetPrice200Response.md)
  - [GetGetRecording200Response](docs/GetGetRecording200Response.md)
+ - [GraphDTO](docs/GraphDTO.md)
  - [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
  - [HostingRegionDTO](docs/HostingRegionDTO.md)
  - [InstallationDetailsDTO](docs/InstallationDetailsDTO.md)
@@ -469,6 +472,7 @@ Class | Method | HTTP request | Description
  - [PortalLoginModel](docs/PortalLoginModel.md)
  - [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
  - [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
+ - [PostGenerateReport200Response](docs/PostGenerateReport200Response.md)
  - [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
  - [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
  - [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
@@ -493,12 +497,14 @@ Class | Method | HTTP request | Description
  - [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
  - [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
  - [RemoteStorageDTO](docs/RemoteStorageDTO.md)
+ - [ReportRequestDTO](docs/ReportRequestDTO.md)
  - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
  - [RootAccessModel](docs/RootAccessModel.md)
  - [S3BucketEntity](docs/S3BucketEntity.md)
  - [SbcDTO](docs/SbcDTO.md)
  - [ScannedItemModel](docs/ScannedItemModel.md)
  - [ScopeModel](docs/ScopeModel.md)
+ - [SeriesDTO](docs/SeriesDTO.md)
  - [ServiceHealthDTO](docs/ServiceHealthDTO.md)
  - [ServiceStatusDTO](docs/ServiceStatusDTO.md)
  - [ShipmentAddressEntity](docs/ShipmentAddressEntity.md)
@@ -559,7 +565,10 @@ Class | Method | HTTP request | Description
  - [SupplierProductModel](docs/SupplierProductModel.md)
  - [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
  - [SupportTicketModel](docs/SupportTicketModel.md)
+ - [TableDTO](docs/TableDTO.md)
+ - [TableDataDTO](docs/TableDataDTO.md)
  - [TableHistoryEntity](docs/TableHistoryEntity.md)
+ - [TableRowDTO](docs/TableRowDTO.md)
  - [TcxBackupEntity](docs/TcxBackupEntity.md)
  - [TcxBackupModel](docs/TcxBackupModel.md)
  - [TcxBillingEntity](docs/TcxBillingEntity.md)

package/api.ts

@@ -1043,6 +1043,33 @@ 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 const AxisDataDTOTypeEnum = {
+    Value: 'value',
+    Category: 'category',
+    Time: 'time',
+    Log: 'log',
+} as const;
+
+export type AxisDataDTOTypeEnum = typeof AxisDataDTOTypeEnum[keyof typeof AxisDataDTOTypeEnum];
+
 /**
  * Basic Order Item
  */
@@ -2629,6 +2656,76 @@ 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 const GraphDTOCurrencyEnum = {
+    Eur: 'EUR',
+    Usd: 'USD',
+    Jpy: 'JPY',
+    Bgn: 'BGN',
+    Czk: 'CZK',
+    Dkk: 'DKK',
+    Gbp: 'GBP',
+    Huf: 'HUF',
+    Pln: 'PLN',
+    Ron: 'RON',
+    Sek: 'SEK',
+    Chf: 'CHF',
+    Isk: 'ISK',
+    Nok: 'NOK',
+    Try: 'TRY',
+    Aud: 'AUD',
+    Brl: 'BRL',
+    Cad: 'CAD',
+    Cny: 'CNY',
+    Hkd: 'HKD',
+    Idr: 'IDR',
+    Ils: 'ILS',
+    Inr: 'INR',
+    Krw: 'KRW',
+    Mxn: 'MXN',
+    Myr: 'MYR',
+    Nzd: 'NZD',
+    Php: 'PHP',
+    Sgd: 'SGD',
+    Thb: 'THB',
+    Zar: 'ZAR',
+} as const;
+
+export type GraphDTOCurrencyEnum = typeof GraphDTOCurrencyEnum[keyof typeof GraphDTOCurrencyEnum];
+
 /**
  * Change Response
  */
@@ -4763,6 +4860,11 @@ export interface PostAddOrderNoteRequest {
 export interface PostAddWebhook200Response {
     'url'?: string;
 }
+/**
+ * @type PostGenerateReport200Response
+ */
+export type PostGenerateReport200Response = GraphDTO | TableDTO;
+
 export interface PostGetClientCredentialsRequest {
     /**
      * OAuth 2.0 scopes
@@ -5350,6 +5452,69 @@ 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 const ReportRequestDTOReportEnum = {
+    _1: '1',
+    _2: '2',
+    _3: '3',
+    _4: '4',
+    _5: '5',
+    _6: '6',
+    _7: '7',
+    _8: '8',
+    _9: '9',
+    _10: '10',
+} as const;
+
+export type ReportRequestDTOReportEnum = typeof ReportRequestDTOReportEnum[keyof typeof ReportRequestDTOReportEnum];
+export const ReportRequestDTOGraphTypeEnum = {
+    StackedArea: 'stacked-area',
+    Table: 'table',
+} as const;
+
+export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
+
 /**
  * Resource Not Ready
  */
@@ -5480,6 +5645,34 @@ 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 const SeriesDTOTypeEnum = {
+    Line: 'line',
+} as const;
+
+export type SeriesDTOTypeEnum = typeof SeriesDTOTypeEnum[keyof typeof SeriesDTOTypeEnum];
+
 /**
  * Service Health DTO
  */
@@ -7348,6 +7541,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
  */
@@ -7385,6 +7601,15 @@ export interface TableHistoryEntity {
      */
     'page'?: number;
 }
+/**
+ * Table Row
+ */
+export interface TableRowDTO {
+    /**
+     * Table Data
+     */
+    'data'?: Array<TableDataDTO>;
+}
 /**
  * 3CX Wizard Restore From Backup
  */
@@ -24793,6 +25018,39 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Generate Reports
+         * @summary Generate Reports
+         * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGenerateReport: async (reportRequestDTO?: ReportRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/reports`;
+            // 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(reportRequestDTO, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -24818,6 +25076,19 @@ export const ReportsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ReportsApi.getGetStockReport']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Generate Reports
+         * @summary Generate Reports
+         * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostGenerateReport200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGenerateReport(reportRequestDTO, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ReportsApi.postGenerateReport']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -24835,6 +25106,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
         getGetStockReport(options?: RawAxiosRequestConfig): AxiosPromise<StockReportModel> {
             return localVarFp.getGetStockReport(options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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> {
+            return localVarFp.postGenerateReport(reportRequestDTO, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -24850,6 +25131,17 @@ export class ReportsApi extends BaseAPI {
     public getGetStockReport(options?: RawAxiosRequestConfig) {
         return ReportsApiFp(this.configuration).getGetStockReport(options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Generate Reports
+     * @summary Generate Reports
+     * @param {ReportRequestDTO} [reportRequestDTO] Report Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig) {
+        return ReportsApiFp(this.configuration).postGenerateReport(reportRequestDTO, options).then((request) => request(this.axios, this.basePath));
+    }
 }