yellowgrid-api-ts 3.2.347 → 3.2.348

package/.openapi-generator/FILES

@@ -368,6 +368,7 @@ docs/TcxBackupEntity.md
 docs/TcxBackupModel.md
 docs/TcxBillingEntity.md
 docs/TcxBulkLicenceDetailsModel.md
+docs/TcxCallLogEntity.md
 docs/TcxDeadLicenceEntity.md
 docs/TcxEngineerTaskDTO.md
 docs/TcxEngineeringDTO.md

package/README.md

@@ -188,6 +188,7 @@ Class | Method | HTTP request | Description
 *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 +793,7 @@ Class | Method | HTTP request | Description
  - [TcxBackupModel](docs/TcxBackupModel.md)
  - [TcxBillingEntity](docs/TcxBillingEntity.md)
  - [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.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,39 @@ export interface TcxBulkLicenceDetailsModel {
      */
     'errors': Array<TcxLicenceDetailsErrorModel>;
 }
+/**
+ * TcxCallLogEntity
+ */
+export interface TcxCallLogEntity {
+    /**
+     * instanceId
+     */
+    'instanceId': string;
+    /**
+     * callId
+     */
+    'callId': number;
+    /**
+     * number
+     */
+    'number': string;
+    /**
+     * dn
+     */
+    'dn': string;
+    /**
+     * device
+     */
+    'device': string;
+    /**
+     * startedAt
+     */
+    'startedAt': string;
+    /**
+     * endedAt
+     */
+    'endedAt': string;
+}
 /**
  * DeadLicencesEntity
  */
@@ -20923,6 +20957,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
@@ -21080,6 +21145,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
@@ -21176,6 +21253,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
@@ -21271,6 +21357,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

package/dist/api.d.ts

@@ -1318,6 +1318,7 @@ export declare const AuditLogEntityTypeEnum: {
     readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
     readonly Pops3cxUsers: "pops_3cx_users";
     readonly _3cxServicePrincipals: "3cx_service_principals";
+    readonly _3cxCallLog: "3cx_call_log";
     readonly PopsUsers: "pops_users";
     readonly PopsVideoRequests: "pops_video_requests";
     readonly Webhook: "webhook";
@@ -9778,6 +9779,39 @@ export interface TcxBulkLicenceDetailsModel {
      */
     'errors': Array<TcxLicenceDetailsErrorModel>;
 }
+/**
+ * TcxCallLogEntity
+ */
+export interface TcxCallLogEntity {
+    /**
+     * instanceId
+     */
+    'instanceId': string;
+    /**
+     * callId
+     */
+    'callId': number;
+    /**
+     * number
+     */
+    'number': string;
+    /**
+     * dn
+     */
+    'dn': string;
+    /**
+     * device
+     */
+    'device': string;
+    /**
+     * startedAt
+     */
+    'startedAt': string;
+    /**
+     * endedAt
+     */
+    'endedAt': string;
+}
 /**
  * DeadLicencesEntity
  */
@@ -15532,6 +15566,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Add to 3CX call log
+     * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddCallLog: (tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX service principals
      * @param {string} id Instance ID
@@ -15600,6 +15641,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
+    /**
+     * Add to 3CX call log
+     * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Get 3CX service principals
      * @param {string} id Instance ID
@@ -15668,6 +15716,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
+    /**
+     * 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>;
     /**
      * Get 3CX service principals
      * @param {string} id Instance ID
@@ -15736,6 +15791,13 @@ export declare class Class3CXApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDTO[], any, {}, any>>;
+    /**
+     * Add to 3CX call log
+     * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
     /**
      * Get 3CX service principals
      * @param {string} id Instance ID

package/dist/api.js

@@ -242,6 +242,7 @@ exports.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',
@@ -11898,6 +11899,41 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Add to 3CX call log
+         * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postAddCallLog: function (tcxCallLogEntity_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([tcxCallLogEntity_1], args_1, true), void 0, function (tcxCallLogEntity, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    localVarPath = "/tcx/cc/call/log";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Content-Type'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(tcxCallLogEntity, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Get 3CX service principals
          * @param {string} id Instance ID
@@ -12133,6 +12169,28 @@ var Class3CXApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Add to 3CX call log
+         * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postAddCallLog: function (tcxCallLogEntity, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddCallLog(tcxCallLogEntity, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.postAddCallLog']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Get 3CX service principals
          * @param {string} id Instance ID
@@ -12249,6 +12307,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
         getGetTcxPartners: function (options) {
             return localVarFp.getGetTcxPartners(options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Add to 3CX call log
+         * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postAddCallLog: function (tcxCallLogEntity, options) {
+            return localVarFp.postAddCallLog(tcxCallLogEntity, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get 3CX service principals
          * @param {string} id Instance ID
@@ -12348,6 +12415,16 @@ var Class3CXApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Add to 3CX call log
+     * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    Class3CXApi.prototype.postAddCallLog = function (tcxCallLogEntity, options) {
+        var _this = this;
+        return (0, exports.Class3CXApiFp)(this.configuration).postAddCallLog(tcxCallLogEntity, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get 3CX service principals
      * @param {string} id Instance ID

package/docs/Class3CXApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
 |[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
 |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
+|[**postAddCallLog**](#postaddcalllog) | **POST** /tcx/cc/call/log | |
 |[**postAuthenticateInstanceWebsocket**](#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} | |
 |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
 
@@ -350,6 +351,61 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **postAddCallLog**
+> postAddCallLog()
+
+Add to 3CX call log
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration,
+    TcxCallLogEntity
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+let tcxCallLogEntity: TcxCallLogEntity; //Call Log (optional)
+
+const { status, data } = await apiInstance.postAddCallLog(
+    tcxCallLogEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxCallLogEntity** | **TcxCallLogEntity**| Call Log | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **postAuthenticateInstanceWebsocket**
 > postAuthenticateInstanceWebsocket()
 

package/docs/TcxCallLogEntity.md

@@ -0,0 +1,33 @@
+# TcxCallLogEntity
+
+TcxCallLogEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instanceId** | **string** | instanceId | [default to undefined]
+**callId** | **number** | callId | [default to undefined]
+**number** | **string** | number | [default to undefined]
+**dn** | **string** | dn | [default to undefined]
+**device** | **string** | device | [default to undefined]
+**startedAt** | **string** | startedAt | [default to undefined]
+**endedAt** | **string** | endedAt | [default to undefined]
+
+## Example
+
+```typescript
+import { TcxCallLogEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxCallLogEntity = {
+    instanceId,
+    callId,
+    number,
+    dn,
+    device,
+    startedAt,
+    endedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.347",
+  "version": "3.2.348",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {