yellowgrid-api-ts 3.2.297 → 3.2.299

package/.openapi-generator/FILES

@@ -50,6 +50,7 @@ docs/Bundle.md
 docs/BundleCustomer.md
 docs/CRMApi.md
 docs/CallBarringModel.md
+docs/CallJournalRequestModel.md
 docs/CallTariff.md
 docs/CallTariffPlan.md
 docs/CallTariffResponse.md

package/README.md

@@ -178,6 +178,7 @@ Class | Method | HTTP request | Description
 *CRMApi* | [**getGetCrmActivities**](docs/CRMApi.md#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | 
 *CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search | 
 *CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | 
+*CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal | 
 *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
 *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
@@ -491,6 +492,7 @@ Class | Method | HTTP request | Description
  - [Bundle](docs/Bundle.md)
  - [BundleCustomer](docs/BundleCustomer.md)
  - [CallBarringModel](docs/CallBarringModel.md)
+ - [CallJournalRequestModel](docs/CallJournalRequestModel.md)
  - [CallTariff](docs/CallTariff.md)
  - [CallTariffPlan](docs/CallTariffPlan.md)
  - [CallTariffResponse](docs/CallTariffResponse.md)

package/api.ts

@@ -1736,6 +1736,43 @@ export interface CallBarringModel {
      */
     'block087Calls': boolean;
 }
+/**
+ * Call Journal Request Model
+ */
+export interface CallJournalRequestModel {
+    /**
+     * User Email
+     */
+    'userEmail': string;
+    /**
+     * Call Note
+     */
+    'note': string;
+    /**
+     * Call Timestamp
+     */
+    'timestamp': string;
+    /**
+     * Call Duration
+     */
+    'duration': string;
+    /**
+     * Call Recording URL
+     */
+    'recordingUrl': string;
+    /**
+     * Call Transcription
+     */
+    'transcription': string;
+    /**
+     * Call Summary
+     */
+    'summary': string;
+    /**
+     * Call Sentiment
+     */
+    'sentiment': number;
+}
 export interface CallTariff {
     'createdDate'?: string;
     'id'?: number;
@@ -2387,6 +2424,22 @@ export interface CrmActivityDTO {
      * Activity Order ID
      */
     'orderId'?: number | null;
+    /**
+     * Call Recording URL
+     */
+    'recordingUrl'?: string | null;
+    /**
+     * Call Transcription
+     */
+    'transcription'?: string | null;
+    /**
+     * Call Summary
+     */
+    'summary'?: string | null;
+    /**
+     * Call Sentiment
+     */
+    'sentiment'?: number | null;
 }
 /**
  * CRM Contact
@@ -20021,6 +20074,42 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
             localVarRequestOptions.data = serializeDataIfNeeded(createCrmNoteBody, localVarRequestOptions, configuration)
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postJournalCall: async (id: number, callJournalRequestModel?: CallJournalRequestModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('postJournalCall', 'id', id)
+            const localVarPath = `/crm/contact/{id}/journal`
+                .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: '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(callJournalRequestModel, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -20073,6 +20162,19 @@ export const CRMApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['CRMApi.postCreateCrmNote']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postJournalCall(id, callJournalRequestModel, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CRMApi.postJournalCall']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -20111,6 +20213,16 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
         postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO> {
             return localVarFp.postCreateCrmNote(id, createCrmNoteBody, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO> {
+            return localVarFp.postJournalCall(id, callJournalRequestModel, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -20149,6 +20261,17 @@ export class CRMApi extends BaseAPI {
     public postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig) {
         return CRMApiFp(this.configuration).postCreateCrmNote(id, createCrmNoteBody, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig) {
+        return CRMApiFp(this.configuration).postJournalCall(id, callJournalRequestModel, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 export const GetGetCrmActivitiesTypeEnum = {

package/dist/api.d.ts

@@ -1694,6 +1694,43 @@ export interface CallBarringModel {
      */
     'block087Calls': boolean;
 }
+/**
+ * Call Journal Request Model
+ */
+export interface CallJournalRequestModel {
+    /**
+     * User Email
+     */
+    'userEmail': string;
+    /**
+     * Call Note
+     */
+    'note': string;
+    /**
+     * Call Timestamp
+     */
+    'timestamp': string;
+    /**
+     * Call Duration
+     */
+    'duration': string;
+    /**
+     * Call Recording URL
+     */
+    'recordingUrl': string;
+    /**
+     * Call Transcription
+     */
+    'transcription': string;
+    /**
+     * Call Summary
+     */
+    'summary': string;
+    /**
+     * Call Sentiment
+     */
+    'sentiment': number;
+}
 export interface CallTariff {
     'createdDate'?: string;
     'id'?: number;
@@ -2345,6 +2382,22 @@ export interface CrmActivityDTO {
      * Activity Order ID
      */
     'orderId'?: number | null;
+    /**
+     * Call Recording URL
+     */
+    'recordingUrl'?: string | null;
+    /**
+     * Call Transcription
+     */
+    'transcription'?: string | null;
+    /**
+     * Call Summary
+     */
+    'summary'?: string | null;
+    /**
+     * Call Sentiment
+     */
+    'sentiment'?: number | null;
 }
 /**
  * CRM Contact
@@ -14981,6 +15034,14 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     postCreateCrmNote: (id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postJournalCall: (id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CRMApi - functional programming interface
@@ -15009,6 +15070,14 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>>;
+    /**
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>>;
 };
 /**
  * CRMApi - factory interface
@@ -15037,6 +15106,14 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
      * @throws {RequiredError}
      */
     postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO>;
+    /**
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO>;
 };
 /**
  * CRMApi - object-oriented interface
@@ -15065,6 +15142,14 @@ export declare class CRMApi extends BaseAPI {
      * @throws {RequiredError}
      */
     postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDTO, any, {}>>;
+    /**
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDTO, any, {}>>;
 }
 export declare const GetGetCrmActivitiesTypeEnum: {
     readonly Alert: "alert";

package/dist/api.js

@@ -11148,6 +11148,46 @@ var CRMApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postJournalCall: function (id_1, callJournalRequestModel_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1, callJournalRequestModel_1], args_1, true), void 0, function (id, callJournalRequestModel, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('postJournalCall', 'id', id);
+                    localVarPath = "/crm/contact/{id}/journal"
+                        .replace('{id}', encodeURIComponent(String(id)));
+                    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';
+                    localVarHeaderParameter['Accept'] = '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)(callJournalRequestModel, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
     };
 };
 exports.CRMApiAxiosParamCreator = CRMApiAxiosParamCreator;
@@ -11225,6 +11265,29 @@ var CRMApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postJournalCall: function (id, callJournalRequestModel, 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.postJournalCall(id, callJournalRequestModel, 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['CRMApi.postJournalCall']) === 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); }];
+                    }
+                });
+            });
+        },
     };
 };
 exports.CRMApiFp = CRMApiFp;
@@ -11263,6 +11326,16 @@ var CRMApiFactory = function (configuration, basePath, axios) {
         postCreateCrmNote: function (id, createCrmNoteBody, options) {
             return localVarFp.postCreateCrmNote(id, createCrmNoteBody, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postJournalCall: function (id, callJournalRequestModel, options) {
+            return localVarFp.postJournalCall(id, callJournalRequestModel, options).then(function (request) { return request(axios, basePath); });
+        },
     };
 };
 exports.CRMApiFactory = CRMApiFactory;
@@ -11306,6 +11379,17 @@ var CRMApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.CRMApiFp)(this.configuration).postCreateCrmNote(id, createCrmNoteBody, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    CRMApi.prototype.postJournalCall = function (id, callJournalRequestModel, options) {
+        var _this = this;
+        return (0, exports.CRMApiFp)(this.configuration).postJournalCall(id, callJournalRequestModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     return CRMApi;
 }(base_1.BaseAPI));
 exports.CRMApi = CRMApi;

package/docs/CRMApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
 |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
 |[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
+|[**postJournalCall**](#postjournalcall) | **POST** /crm/contact/{id}/journal | |
 
 # **getGetCrmActivities**
 > CrmActivitiesResponseDTO getGetCrmActivities()
@@ -173,3 +174,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)
 
+# **postJournalCall**
+> CrmActivityDTO postJournalCall()
+
+Journal a phone call
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration,
+    CallJournalRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Contact ID (default to undefined)
+let callJournalRequestModel: CallJournalRequestModel; //Journal Call Request (optional)
+
+const { status, data } = await apiInstance.postJournalCall(
+    id,
+    callJournalRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **callJournalRequestModel** | **CallJournalRequestModel**| Journal Call Request | |
+| **id** | [**number**] | Contact ID | defaults to undefined|
+
+
+### Return type
+
+**CrmActivityDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Contact |  -  |
+|**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)
+

package/docs/CallJournalRequestModel.md

@@ -0,0 +1,35 @@
+# CallJournalRequestModel
+
+Call Journal Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userEmail** | **string** | User Email | [default to undefined]
+**note** | **string** | Call Note | [default to undefined]
+**timestamp** | **string** | Call Timestamp | [default to undefined]
+**duration** | **string** | Call Duration | [default to undefined]
+**recordingUrl** | **string** | Call Recording URL | [default to undefined]
+**transcription** | **string** | Call Transcription | [default to undefined]
+**summary** | **string** | Call Summary | [default to undefined]
+**sentiment** | **number** | Call Sentiment | [default to undefined]
+
+## Example
+
+```typescript
+import { CallJournalRequestModel } from 'yellowgrid-api-ts';
+
+const instance: CallJournalRequestModel = {
+    userEmail,
+    note,
+    timestamp,
+    duration,
+    recordingUrl,
+    transcription,
+    summary,
+    sentiment,
+};
+```
+
+[[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/docs/CrmActivityDTO.md

@@ -13,6 +13,10 @@ Name | Type | Description | Notes
 **user** | **string** | Activity User Name | [optional] [default to undefined]
 **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
 **orderId** | **number** | Activity Order ID | [optional] [default to undefined]
+**recordingUrl** | **string** | Call Recording URL | [optional] [default to undefined]
+**transcription** | **string** | Call Transcription | [optional] [default to undefined]
+**summary** | **string** | Call Summary | [optional] [default to undefined]
+**sentiment** | **number** | Call Sentiment | [optional] [default to undefined]
 
 ## Example
 
@@ -27,6 +31,10 @@ const instance: CrmActivityDTO = {
     user,
     contact,
     orderId,
+    recordingUrl,
+    transcription,
+    summary,
+    sentiment,
 };
 ```
 

package/package.json

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