yellowgrid-api-ts 3.2.347 → 3.2.354

package/.openapi-generator/FILES

@@ -1,6 +1,5 @@
 .gitignore
 .npmignore
-.openapi-generator-ignore
 README.md
 api.ts
 base.ts
@@ -368,6 +367,8 @@ docs/TcxBackupEntity.md
 docs/TcxBackupModel.md
 docs/TcxBillingEntity.md
 docs/TcxBulkLicenceDetailsModel.md
+docs/TcxCallLogCollectionModel.md
+docs/TcxCallLogEntity.md
 docs/TcxDeadLicenceEntity.md
 docs/TcxEngineerTaskDTO.md
 docs/TcxEngineeringDTO.md
@@ -416,4 +417,3 @@ docs/XeroLogEntity.md
 git_push.sh
 index.ts
 package.json
-tsconfig.json

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.26.0
+7.27.0

package/.openapi-generator-ignore

@@ -21,3 +21,4 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+tsconfig.json

package/README.md

@@ -182,12 +182,14 @@ Class | Method | HTTP request | Description
 *CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | 
 *CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal | 
 *Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices | 
+*Class3CXApi* | [**getGetCallHistory**](docs/Class3CXApi.md#getgetcallhistory) | **GET** /tcx/cc/instance/{id}/calls | 
 *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
 *Class3CXApi* | [**getGetServicePrincipals**](docs/Class3CXApi.md#getgetserviceprincipals) | **GET** /tcx/cc/services | 
 *Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
 *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
 *Class3CXApi* | [**getGetTcxExpiringKeysCsv**](docs/Class3CXApi.md#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
 *Class3CXApi* | [**getGetTcxPartners**](docs/Class3CXApi.md#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners
+*Class3CXApi* | [**postAddCallLog**](docs/Class3CXApi.md#postaddcalllog) | **POST** /tcx/cc/call/log | 
 *Class3CXApi* | [**postAuthenticateInstanceWebsocket**](docs/Class3CXApi.md#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} | 
 *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
 *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
@@ -792,6 +794,8 @@ Class | Method | HTTP request | Description
  - [TcxBackupModel](docs/TcxBackupModel.md)
  - [TcxBillingEntity](docs/TcxBillingEntity.md)
  - [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
+ - [TcxCallLogCollectionModel](docs/TcxCallLogCollectionModel.md)
+ - [TcxCallLogEntity](docs/TcxCallLogEntity.md)
  - [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
  - [TcxEngineerTaskDTO](docs/TcxEngineerTaskDTO.md)
  - [TcxEngineeringDTO](docs/TcxEngineeringDTO.md)

package/api.ts

@@ -1351,6 +1351,7 @@ export const AuditLogEntityTypeEnum = {
     Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
     Pops3cxUsers: 'pops_3cx_users',
     _3cxServicePrincipals: '3cx_service_principals',
+    _3cxCallLog: '3cx_call_log',
     PopsUsers: 'pops_users',
     PopsVideoRequests: 'pops_video_requests',
     Webhook: 'webhook',
@@ -9971,6 +9972,67 @@ export interface TcxBulkLicenceDetailsModel {
      */
     'errors': Array<TcxLicenceDetailsErrorModel>;
 }
+/**
+ * 3CX Call Log Collection
+ */
+export interface TcxCallLogCollectionModel {
+    /**
+     * Calls
+     */
+    'calls': Array<TcxCallLogEntity>;
+    /**
+     * Peak Active Calls
+     */
+    'active': number;
+}
+/**
+ * TcxCallLogEntity
+ */
+export interface TcxCallLogEntity {
+    /**
+     * instanceId
+     */
+    'instanceId': string;
+    /**
+     * callId
+     */
+    'callId': number;
+    /**
+     * number
+     */
+    'type': string;
+    /**
+     * type
+     */
+    'number': TcxCallLogEntityNumberEnum;
+    /**
+     * dn
+     */
+    'dn': string;
+    /**
+     * device
+     */
+    'device': string;
+    /**
+     * startedAt
+     */
+    'startedAt': string;
+    /**
+     * endedAt
+     */
+    'endedAt': string;
+}
+
+export const TcxCallLogEntityNumberEnum = {
+    Dialing: 'dialing',
+    Ended: 'ended',
+    Call: 'call',
+    Ringing: 'ringing',
+    Connected: 'connected',
+} as const;
+
+export type TcxCallLogEntityNumberEnum = typeof TcxCallLogEntityNumberEnum[keyof typeof TcxCallLogEntityNumberEnum];
+
 /**
  * DeadLicencesEntity
  */
@@ -20737,6 +20799,60 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get 3CX call history
+         * @param {string} id Instance ID
+         * @param {string} trunk Trunk
+         * @param {string} [start] Start Date
+         * @param {string} [end] End Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCallHistory: async (id: string, trunk: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetCallHistory', 'id', id)
+            // verify required parameter 'trunk' is not null or undefined
+            assertParamExists('getGetCallHistory', 'trunk', trunk)
+            const localVarPath = `/tcx/cc/instance/{id}/calls`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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 (start !== undefined) {
+                localVarQueryParameter['start'] = (start as any instanceof Date) ?
+                    (start as any).toISOString().substring(0,10) :
+                    start;
+            }
+
+            if (end !== undefined) {
+                localVarQueryParameter['end'] = (end as any instanceof Date) ?
+                    (end as any).toISOString().substring(0,10) :
+                    end;
+            }
+
+            if (trunk !== undefined) {
+                localVarQueryParameter['trunk'] = trunk;
+            }
+
+            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 3CX Licence Details
          * @summary Get 3CX Licence Details
@@ -20923,6 +21039,37 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Add to 3CX call log
+         * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postAddCallLog: async (tcxCallLogEntity?: TcxCallLogEntity, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/tcx/cc/call/log`;
+            // 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';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(tcxCallLogEntity, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get 3CX service principals
          * @param {string} id Instance ID
@@ -21008,6 +21155,21 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetCCDevices']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get 3CX call history
+         * @param {string} id Instance ID
+         * @param {string} trunk Trunk
+         * @param {string} [start] Start Date
+         * @param {string} [end] End Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetCallHistory(id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxCallLogCollectionModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCallHistory(id, trunk, start, end, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetCallHistory']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get 3CX Licence Details
          * @summary Get 3CX Licence Details
@@ -21080,6 +21242,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Add to 3CX call log
+         * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postAddCallLog(tcxCallLogEntity, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXApi.postAddCallLog']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get 3CX service principals
          * @param {string} id Instance ID
@@ -21122,6 +21296,18 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
         getGetCCDevices(options?: RawAxiosRequestConfig): AxiosPromise<Array<DeviceModel>> {
             return localVarFp.getGetCCDevices(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get 3CX call history
+         * @param {string} id Instance ID
+         * @param {string} trunk Trunk
+         * @param {string} [start] Start Date
+         * @param {string} [end] End Date
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCallHistory(id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxCallLogCollectionModel> {
+            return localVarFp.getGetCallHistory(id, trunk, start, end, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get 3CX Licence Details
          * @summary Get 3CX Licence Details
@@ -21176,6 +21362,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
         getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>> {
             return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Add to 3CX call log
+         * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.postAddCallLog(tcxCallLogEntity, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get 3CX service principals
          * @param {string} id Instance ID
@@ -21211,6 +21406,19 @@ export class Class3CXApi extends BaseAPI {
         return Class3CXApiFp(this.configuration).getGetCCDevices(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get 3CX call history
+     * @param {string} id Instance ID
+     * @param {string} trunk Trunk
+     * @param {string} [start] Start Date
+     * @param {string} [end] End Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetCallHistory(id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig) {
+        return Class3CXApiFp(this.configuration).getGetCallHistory(id, trunk, start, end, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get 3CX Licence Details
      * @summary Get 3CX Licence Details
@@ -21271,6 +21479,16 @@ export class Class3CXApi extends BaseAPI {
         return Class3CXApiFp(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Add to 3CX call log
+     * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig) {
+        return Class3CXApiFp(this.configuration).postAddCallLog(tcxCallLogEntity, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get 3CX service principals
      * @param {string} id Instance ID