ch-chat-api-typescript-axios 5.86.0 → 5.87.3

package/dist/api/dashboard-api.d.ts

@@ -12,12 +12,13 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
-import type { DashboardActivatedSessionsModel } from '../models';
+import type { DashboardRecentSessionsModel } from '../models';
 import type { DashboardSessionCountriesStatisticsModel } from '../models';
+import type { DashboardSessionHospitalsStatisticsModel } from '../models';
 import type { DashboardSessionTrendsStatisticsModel } from '../models';
-import type { Duration } from '../models';
 import type { PlatformTypes } from '../models';
 import type { SortBy } from '../models';
+import type { TimeframeDuration } from '../models';
 /**
  * DashboardApi - axios parameter creator
  * @export
@@ -25,35 +26,51 @@ import type { SortBy } from '../models';
 export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary Get current activated chat session status.
+     * @summary Shows the count of created chat sessions aggregated by the country code of the phone number.
      * @param {string} [tenantId]
-     * @param {string} [assigneeId]
-     * @param {PlatformTypes} [platformType]
+     * @param {SortBy} [sortBy] Sort by value cost
+     * @param {number} [page]
+     * @param {number} [limit]
+     * @param {Date} [lastRetrieved]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV1ChatDashboardSessionsActivatedCountGet: (tenantId?: string, assigneeId?: string, platformType?: PlatformTypes, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    apiV1ChatDashboardSessionsCountriesGet: (tenantId?: string, sortBy?: SortBy, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Get current all chat session status.
+     * @summary Retrieves the number of chat sessions created during a specified period
+     * @param {TimeframeDuration} duration
      * @param {string} [tenantId]
-     * @param {SortBy} [sortBy] Sort by value cost
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1ChatDashboardSessionsCountsGet: (duration: TimeframeDuration, tenantId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets the number of chat sessions created per hospital.
+     * @param {string} [tenantId]
+     * @param {string} [hospitalName]
+     * @param {SortBy} [sortBy]
      * @param {number} [page]
      * @param {number} [limit]
      * @param {Date} [lastRetrieved]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV1ChatDashboardSessionsCountriesGet: (tenantId?: string, sortBy?: SortBy, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    apiV1ChatDashboardSessionsHospitalsAggregateGet: (tenantId?: string, hospitalName?: string, sortBy?: SortBy, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Get created and expired chat session statistics trends.
-     * @param {Duration} duration
+     * @summary Get recent chat session data from the past 48 hours.
      * @param {string} [tenantId]
+     * @param {string} [assigneeId]
+     * @param {PlatformTypes} [platformType]
+     * @param {number} [page]
+     * @param {number} [limit]
+     * @param {Date} [lastRetrieved]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV1ChatDashboardSessionsCountsGet: (duration: Duration, tenantId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    apiV1ChatDashboardSessionsRecentGet: (tenantId?: string, assigneeId?: string, platformType?: PlatformTypes, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * DashboardApi - functional programming interface
@@ -62,35 +79,51 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
 export declare const DashboardApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary Get current activated chat session status.
+     * @summary Shows the count of created chat sessions aggregated by the country code of the phone number.
      * @param {string} [tenantId]
-     * @param {string} [assigneeId]
-     * @param {PlatformTypes} [platformType]
+     * @param {SortBy} [sortBy] Sort by value cost
+     * @param {number} [page]
+     * @param {number} [limit]
+     * @param {Date} [lastRetrieved]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV1ChatDashboardSessionsActivatedCountGet(tenantId?: string, assigneeId?: string, platformType?: PlatformTypes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardActivatedSessionsModel>>;
+    apiV1ChatDashboardSessionsCountriesGet(tenantId?: string, sortBy?: SortBy, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardSessionCountriesStatisticsModel>>;
     /**
      *
-     * @summary Get current all chat session status.
+     * @summary Retrieves the number of chat sessions created during a specified period
+     * @param {TimeframeDuration} duration
      * @param {string} [tenantId]
-     * @param {SortBy} [sortBy] Sort by value cost
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1ChatDashboardSessionsCountsGet(duration: TimeframeDuration, tenantId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardSessionTrendsStatisticsModel>>;
+    /**
+     *
+     * @summary Gets the number of chat sessions created per hospital.
+     * @param {string} [tenantId]
+     * @param {string} [hospitalName]
+     * @param {SortBy} [sortBy]
      * @param {number} [page]
      * @param {number} [limit]
      * @param {Date} [lastRetrieved]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV1ChatDashboardSessionsCountriesGet(tenantId?: string, sortBy?: SortBy, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardSessionCountriesStatisticsModel>>;
+    apiV1ChatDashboardSessionsHospitalsAggregateGet(tenantId?: string, hospitalName?: string, sortBy?: SortBy, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardSessionHospitalsStatisticsModel>>;
     /**
      *
-     * @summary Get created and expired chat session statistics trends.
-     * @param {Duration} duration
+     * @summary Get recent chat session data from the past 48 hours.
      * @param {string} [tenantId]
+     * @param {string} [assigneeId]
+     * @param {PlatformTypes} [platformType]
+     * @param {number} [page]
+     * @param {number} [limit]
+     * @param {Date} [lastRetrieved]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    apiV1ChatDashboardSessionsCountsGet(duration: Duration, tenantId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardSessionTrendsStatisticsModel>>;
+    apiV1ChatDashboardSessionsRecentGet(tenantId?: string, assigneeId?: string, platformType?: PlatformTypes, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardRecentSessionsModel>>;
 };
 /**
  * DashboardApi - factory interface
@@ -99,15 +132,7 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
 export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary Get current activated chat session status.
-     * @param {DashboardApiApiV1ChatDashboardSessionsActivatedCountGetRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    apiV1ChatDashboardSessionsActivatedCountGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsActivatedCountGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardActivatedSessionsModel>;
-    /**
-     *
-     * @summary Get current all chat session status.
+     * @summary Shows the count of created chat sessions aggregated by the country code of the phone number.
      * @param {DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -115,38 +140,29 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
     apiV1ChatDashboardSessionsCountriesGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardSessionCountriesStatisticsModel>;
     /**
      *
-     * @summary Get created and expired chat session statistics trends.
+     * @summary Retrieves the number of chat sessions created during a specified period
      * @param {DashboardApiApiV1ChatDashboardSessionsCountsGetRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     apiV1ChatDashboardSessionsCountsGet(requestParameters: DashboardApiApiV1ChatDashboardSessionsCountsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardSessionTrendsStatisticsModel>;
-};
-/**
- * Request parameters for apiV1ChatDashboardSessionsActivatedCountGet operation in DashboardApi.
- * @export
- * @interface DashboardApiApiV1ChatDashboardSessionsActivatedCountGetRequest
- */
-export interface DashboardApiApiV1ChatDashboardSessionsActivatedCountGetRequest {
     /**
      *
-     * @type {string}
-     * @memberof DashboardApiApiV1ChatDashboardSessionsActivatedCountGet
-     */
-    readonly tenantId?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof DashboardApiApiV1ChatDashboardSessionsActivatedCountGet
+     * @summary Gets the number of chat sessions created per hospital.
+     * @param {DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
      */
-    readonly assigneeId?: string;
+    apiV1ChatDashboardSessionsHospitalsAggregateGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardSessionHospitalsStatisticsModel>;
     /**
      *
-     * @type {PlatformTypes}
-     * @memberof DashboardApiApiV1ChatDashboardSessionsActivatedCountGet
+     * @summary Get recent chat session data from the past 48 hours.
+     * @param {DashboardApiApiV1ChatDashboardSessionsRecentGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
      */
-    readonly platformType?: PlatformTypes;
-}
+    apiV1ChatDashboardSessionsRecentGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsRecentGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardRecentSessionsModel>;
+};
 /**
  * Request parameters for apiV1ChatDashboardSessionsCountriesGet operation in DashboardApi.
  * @export
@@ -192,10 +208,10 @@ export interface DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest {
 export interface DashboardApiApiV1ChatDashboardSessionsCountsGetRequest {
     /**
      *
-     * @type {Duration}
+     * @type {TimeframeDuration}
      * @memberof DashboardApiApiV1ChatDashboardSessionsCountsGet
      */
-    readonly duration: Duration;
+    readonly duration: TimeframeDuration;
     /**
      *
      * @type {string}
@@ -203,6 +219,92 @@ export interface DashboardApiApiV1ChatDashboardSessionsCountsGetRequest {
      */
     readonly tenantId?: string;
 }
+/**
+ * Request parameters for apiV1ChatDashboardSessionsHospitalsAggregateGet operation in DashboardApi.
+ * @export
+ * @interface DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGetRequest
+ */
+export interface DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGetRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGet
+     */
+    readonly tenantId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGet
+     */
+    readonly hospitalName?: string;
+    /**
+     *
+     * @type {SortBy}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGet
+     */
+    readonly sortBy?: SortBy;
+    /**
+     *
+     * @type {number}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGet
+     */
+    readonly page?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGet
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGet
+     */
+    readonly lastRetrieved?: Date;
+}
+/**
+ * Request parameters for apiV1ChatDashboardSessionsRecentGet operation in DashboardApi.
+ * @export
+ * @interface DashboardApiApiV1ChatDashboardSessionsRecentGetRequest
+ */
+export interface DashboardApiApiV1ChatDashboardSessionsRecentGetRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsRecentGet
+     */
+    readonly tenantId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsRecentGet
+     */
+    readonly assigneeId?: string;
+    /**
+     *
+     * @type {PlatformTypes}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsRecentGet
+     */
+    readonly platformType?: PlatformTypes;
+    /**
+     *
+     * @type {number}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsRecentGet
+     */
+    readonly page?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsRecentGet
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof DashboardApiApiV1ChatDashboardSessionsRecentGet
+     */
+    readonly lastRetrieved?: Date;
+}
 /**
  * DashboardApi - object-oriented interface
  * @export
@@ -212,29 +314,38 @@ export interface DashboardApiApiV1ChatDashboardSessionsCountsGetRequest {
 export declare class DashboardApi extends BaseAPI {
     /**
      *
-     * @summary Get current activated chat session status.
-     * @param {DashboardApiApiV1ChatDashboardSessionsActivatedCountGetRequest} requestParameters Request parameters.
+     * @summary Shows the count of created chat sessions aggregated by the country code of the phone number.
+     * @param {DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DashboardApi
      */
-    apiV1ChatDashboardSessionsActivatedCountGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsActivatedCountGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardActivatedSessionsModel, any>>;
+    apiV1ChatDashboardSessionsCountriesGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardSessionCountriesStatisticsModel, any>>;
     /**
      *
-     * @summary Get current all chat session status.
-     * @param {DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest} requestParameters Request parameters.
+     * @summary Retrieves the number of chat sessions created during a specified period
+     * @param {DashboardApiApiV1ChatDashboardSessionsCountsGetRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DashboardApi
      */
-    apiV1ChatDashboardSessionsCountriesGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsCountriesGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardSessionCountriesStatisticsModel, any>>;
+    apiV1ChatDashboardSessionsCountsGet(requestParameters: DashboardApiApiV1ChatDashboardSessionsCountsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardSessionTrendsStatisticsModel, any>>;
     /**
      *
-     * @summary Get created and expired chat session statistics trends.
-     * @param {DashboardApiApiV1ChatDashboardSessionsCountsGetRequest} requestParameters Request parameters.
+     * @summary Gets the number of chat sessions created per hospital.
+     * @param {DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGetRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DashboardApi
      */
-    apiV1ChatDashboardSessionsCountsGet(requestParameters: DashboardApiApiV1ChatDashboardSessionsCountsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardSessionTrendsStatisticsModel, any>>;
+    apiV1ChatDashboardSessionsHospitalsAggregateGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsHospitalsAggregateGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardSessionHospitalsStatisticsModel, any>>;
+    /**
+     *
+     * @summary Get recent chat session data from the past 48 hours.
+     * @param {DashboardApiApiV1ChatDashboardSessionsRecentGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    apiV1ChatDashboardSessionsRecentGet(requestParameters?: DashboardApiApiV1ChatDashboardSessionsRecentGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DashboardRecentSessionsModel, any>>;
 }