yellowgrid-api-ts 3.2.298 → 3.2.300

package/README.md

@@ -178,7 +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* | [**postSearchByPhone**](docs/CRMApi.md#postsearchbyphone) | **POST** /crm/contact/search | 
+*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

package/api.ts

@@ -20080,12 +20080,17 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
             };
         },
         /**
-         * Search for contacts by phone number
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/crm/contact/search`;
+        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;
@@ -20097,11 +20102,13 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
             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),
@@ -20156,14 +20163,16 @@ export const CRMApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Search for contacts by phone number
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async postSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.postSearchByPhone(options);
+        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.postSearchByPhone']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['CRMApi.postJournalCall']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     }
@@ -20205,12 +20214,14 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
             return localVarFp.postCreateCrmNote(id, createCrmNoteBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Search for contacts by phone number
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
-            return localVarFp.postSearchByPhone(options).then((request) => request(axios, basePath));
+        postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO> {
+            return localVarFp.postJournalCall(id, callJournalRequestModel, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -20252,12 +20263,14 @@ export class CRMApi extends BaseAPI {
     }
 
     /**
-     * Search for contacts by phone number
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public postSearchByPhone(options?: RawAxiosRequestConfig) {
-        return CRMApiFp(this.configuration).postSearchByPhone(options).then((request) => request(this.axios, this.basePath));
+    public postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig) {
+        return CRMApiFp(this.configuration).postJournalCall(id, callJournalRequestModel, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

package/dist/api.d.ts

@@ -15035,11 +15035,13 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
      */
     postCreateCrmNote: (id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Search for contacts by phone number
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postJournalCall: (id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CRMApi - functional programming interface
@@ -15069,11 +15071,13 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
      */
     postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>>;
     /**
-     * Search for contacts by phone number
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
+    postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>>;
 };
 /**
  * CRMApi - factory interface
@@ -15103,11 +15107,13 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
      */
     postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO>;
     /**
-     * Search for contacts by phone number
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
+    postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO>;
 };
 /**
  * CRMApi - object-oriented interface
@@ -15137,11 +15143,13 @@ export declare class CRMApi extends BaseAPI {
      */
     postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDTO, any, {}>>;
     /**
-     * Search for contacts by phone number
+     * Journal a phone call
+     * @param {number} id Contact ID
+     * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}>>;
+    postJournalCall(id: number, callJournalRequestModel?: CallJournalRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDTO, any, {}>>;
 }
 export declare const GetGetCrmActivitiesTypeEnum: {
     readonly Alert: "alert";

package/dist/api.js

@@ -11149,20 +11149,25 @@ var CRMApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Search for contacts by phone number
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postSearchByPhone: function () {
+        postJournalCall: function (id_1, callJournalRequestModel_1) {
             var args_1 = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args_1[_i] = arguments[_i];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
             }
-            return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
+            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) {
-                    localVarPath = "/crm/contact/search";
+                    // 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;
@@ -11170,10 +11175,12 @@ var CRMApiAxiosParamCreator = function (configuration) {
                     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,
@@ -11259,21 +11266,23 @@ var CRMApiFp = function (configuration) {
             });
         },
         /**
-         * Search for contacts by phone number
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postSearchByPhone: function (options) {
+        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.postSearchByPhone(options)];
+                        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.postSearchByPhone']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            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); }];
                     }
                 });
@@ -11318,12 +11327,14 @@ var CRMApiFactory = function (configuration, basePath, axios) {
             return localVarFp.postCreateCrmNote(id, createCrmNoteBody, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Search for contacts by phone number
+         * Journal a phone call
+         * @param {number} id Contact ID
+         * @param {CallJournalRequestModel} [callJournalRequestModel] Journal Call Request
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postSearchByPhone: function (options) {
-            return localVarFp.postSearchByPhone(options).then(function (request) { return request(axios, basePath); });
+        postJournalCall: function (id, callJournalRequestModel, options) {
+            return localVarFp.postJournalCall(id, callJournalRequestModel, options).then(function (request) { return request(axios, basePath); });
         },
     };
 };
@@ -11369,13 +11380,15 @@ var CRMApi = /** @class */ (function (_super) {
         return (0, exports.CRMApiFp)(this.configuration).postCreateCrmNote(id, createCrmNoteBody, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Search for contacts by phone number
+     * 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.postSearchByPhone = function (options) {
+    CRMApi.prototype.postJournalCall = function (id, callJournalRequestModel, options) {
         var _this = this;
-        return (0, exports.CRMApiFp)(this.configuration).postSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.CRMApiFp)(this.configuration).postJournalCall(id, callJournalRequestModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     return CRMApi;
 }(base_1.BaseAPI));

package/docs/CRMApi.md

@@ -7,7 +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 | |
-|[**postSearchByPhone**](#postsearchbyphone) | **POST** /crm/contact/search | |
+|[**postJournalCall**](#postjournalcall) | **POST** /crm/contact/{id}/journal | |
 
 # **getGetCrmActivities**
 > CrmActivitiesResponseDTO getGetCrmActivities()
@@ -174,32 +174,43 @@ 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)
 
-# **postSearchByPhone**
-> CrmContactDTO postSearchByPhone()
+# **postJournalCall**
+> CrmActivityDTO postJournalCall()
 
-Search for contacts by phone number
+Journal a phone call
 
 ### Example
 
 ```typescript
 import {
     CRMApi,
-    Configuration
+    Configuration,
+    CallJournalRequestModel
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new CRMApi(configuration);
 
-const { status, data } = await apiInstance.postSearchByPhone();
+let id: number; //Contact ID (default to undefined)
+let callJournalRequestModel: CallJournalRequestModel; //Journal Call Request (optional)
+
+const { status, data } = await apiInstance.postJournalCall(
+    id,
+    callJournalRequestModel
+);
 ```
 
 ### Parameters
-This endpoint does not have any parameters.
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **callJournalRequestModel** | **CallJournalRequestModel**| Journal Call Request | |
+| **id** | [**number**] | Contact ID | defaults to undefined|
 
 
 ### Return type
 
-**CrmContactDTO**
+**CrmActivityDTO**
 
 ### Authorization
 
@@ -207,7 +218,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/package.json

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