yellowgrid-api-ts 3.2.346 → 3.2.348

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -368,6 +368,7 @@ docs/TcxBackupEntity.md
368
368
  docs/TcxBackupModel.md
369
369
  docs/TcxBillingEntity.md
370
370
  docs/TcxBulkLicenceDetailsModel.md
371
+ docs/TcxCallLogEntity.md
371
372
  docs/TcxDeadLicenceEntity.md
372
373
  docs/TcxEngineerTaskDTO.md
373
374
  docs/TcxEngineeringDTO.md
package/README.md CHANGED
@@ -188,6 +188,7 @@ Class | Method | HTTP request | Description
188
188
  *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
189
189
  *Class3CXApi* | [**getGetTcxExpiringKeysCsv**](docs/Class3CXApi.md#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
190
190
  *Class3CXApi* | [**getGetTcxPartners**](docs/Class3CXApi.md#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners
191
+ *Class3CXApi* | [**postAddCallLog**](docs/Class3CXApi.md#postaddcalllog) | **POST** /tcx/cc/call/log |
191
192
  *Class3CXApi* | [**postAuthenticateInstanceWebsocket**](docs/Class3CXApi.md#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} |
192
193
  *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
193
194
  *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
@@ -792,6 +793,7 @@ Class | Method | HTTP request | Description
792
793
  - [TcxBackupModel](docs/TcxBackupModel.md)
793
794
  - [TcxBillingEntity](docs/TcxBillingEntity.md)
794
795
  - [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
796
+ - [TcxCallLogEntity](docs/TcxCallLogEntity.md)
795
797
  - [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
796
798
  - [TcxEngineerTaskDTO](docs/TcxEngineerTaskDTO.md)
797
799
  - [TcxEngineeringDTO](docs/TcxEngineeringDTO.md)
package/api.ts CHANGED
@@ -1351,6 +1351,7 @@ export const AuditLogEntityTypeEnum = {
1351
1351
  Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
1352
1352
  Pops3cxUsers: 'pops_3cx_users',
1353
1353
  _3cxServicePrincipals: '3cx_service_principals',
1354
+ _3cxCallLog: '3cx_call_log',
1354
1355
  PopsUsers: 'pops_users',
1355
1356
  PopsVideoRequests: 'pops_video_requests',
1356
1357
  Webhook: 'webhook',
@@ -9971,6 +9972,39 @@ export interface TcxBulkLicenceDetailsModel {
9971
9972
  */
9972
9973
  'errors': Array<TcxLicenceDetailsErrorModel>;
9973
9974
  }
9975
+ /**
9976
+ * TcxCallLogEntity
9977
+ */
9978
+ export interface TcxCallLogEntity {
9979
+ /**
9980
+ * instanceId
9981
+ */
9982
+ 'instanceId': string;
9983
+ /**
9984
+ * callId
9985
+ */
9986
+ 'callId': number;
9987
+ /**
9988
+ * number
9989
+ */
9990
+ 'number': string;
9991
+ /**
9992
+ * dn
9993
+ */
9994
+ 'dn': string;
9995
+ /**
9996
+ * device
9997
+ */
9998
+ 'device': string;
9999
+ /**
10000
+ * startedAt
10001
+ */
10002
+ 'startedAt': string;
10003
+ /**
10004
+ * endedAt
10005
+ */
10006
+ 'endedAt': string;
10007
+ }
9974
10008
  /**
9975
10009
  * DeadLicencesEntity
9976
10010
  */
@@ -20423,10 +20457,13 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
20423
20457
  },
20424
20458
  /**
20425
20459
  * Search for contacts by phone number
20460
+ * @param {string} phone Phone Number
20426
20461
  * @param {*} [options] Override http request option.
20427
20462
  * @throws {RequiredError}
20428
20463
  */
20429
- getSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20464
+ getSearchByPhone: async (phone: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20465
+ // verify required parameter 'phone' is not null or undefined
20466
+ assertParamExists('getSearchByPhone', 'phone', phone)
20430
20467
  const localVarPath = `/crm/contact/search`;
20431
20468
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
20432
20469
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -20439,6 +20476,10 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
20439
20476
  const localVarHeaderParameter = {} as any;
20440
20477
  const localVarQueryParameter = {} as any;
20441
20478
 
20479
+ if (phone !== undefined) {
20480
+ localVarQueryParameter['phone'] = phone;
20481
+ }
20482
+
20442
20483
  localVarHeaderParameter['Accept'] = 'application/json';
20443
20484
 
20444
20485
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -20547,11 +20588,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
20547
20588
  },
20548
20589
  /**
20549
20590
  * Search for contacts by phone number
20591
+ * @param {string} phone Phone Number
20550
20592
  * @param {*} [options] Override http request option.
20551
20593
  * @throws {RequiredError}
20552
20594
  */
20553
- async getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
20554
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(options);
20595
+ async getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
20596
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(phone, options);
20555
20597
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
20556
20598
  const localVarOperationServerBasePath = operationServerMap['CRMApi.getSearchByPhone']?.[localVarOperationServerIndex]?.url;
20557
20599
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -20604,11 +20646,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
20604
20646
  },
20605
20647
  /**
20606
20648
  * Search for contacts by phone number
20649
+ * @param {string} phone Phone Number
20607
20650
  * @param {*} [options] Override http request option.
20608
20651
  * @throws {RequiredError}
20609
20652
  */
20610
- getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
20611
- return localVarFp.getSearchByPhone(options).then((request) => request(axios, basePath));
20653
+ getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
20654
+ return localVarFp.getSearchByPhone(phone, options).then((request) => request(axios, basePath));
20612
20655
  },
20613
20656
  /**
20614
20657
  * Create CRM Note
@@ -20651,11 +20694,12 @@ export class CRMApi extends BaseAPI {
20651
20694
 
20652
20695
  /**
20653
20696
  * Search for contacts by phone number
20697
+ * @param {string} phone Phone Number
20654
20698
  * @param {*} [options] Override http request option.
20655
20699
  * @throws {RequiredError}
20656
20700
  */
20657
- public getSearchByPhone(options?: RawAxiosRequestConfig) {
20658
- return CRMApiFp(this.configuration).getSearchByPhone(options).then((request) => request(this.axios, this.basePath));
20701
+ public getSearchByPhone(phone: string, options?: RawAxiosRequestConfig) {
20702
+ return CRMApiFp(this.configuration).getSearchByPhone(phone, options).then((request) => request(this.axios, this.basePath));
20659
20703
  }
20660
20704
 
20661
20705
  /**
@@ -20913,6 +20957,37 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
20913
20957
  options: localVarRequestOptions,
20914
20958
  };
20915
20959
  },
20960
+ /**
20961
+ * Add to 3CX call log
20962
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
20963
+ * @param {*} [options] Override http request option.
20964
+ * @throws {RequiredError}
20965
+ */
20966
+ postAddCallLog: async (tcxCallLogEntity?: TcxCallLogEntity, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20967
+ const localVarPath = `/tcx/cc/call/log`;
20968
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20969
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20970
+ let baseOptions;
20971
+ if (configuration) {
20972
+ baseOptions = configuration.baseOptions;
20973
+ }
20974
+
20975
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
20976
+ const localVarHeaderParameter = {} as any;
20977
+ const localVarQueryParameter = {} as any;
20978
+
20979
+ localVarHeaderParameter['Content-Type'] = 'application/json';
20980
+
20981
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20982
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20983
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20984
+ localVarRequestOptions.data = serializeDataIfNeeded(tcxCallLogEntity, localVarRequestOptions, configuration)
20985
+
20986
+ return {
20987
+ url: toPathString(localVarUrlObj),
20988
+ options: localVarRequestOptions,
20989
+ };
20990
+ },
20916
20991
  /**
20917
20992
  * Get 3CX service principals
20918
20993
  * @param {string} id Instance ID
@@ -21070,6 +21145,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
21070
21145
  const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
21071
21146
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21072
21147
  },
21148
+ /**
21149
+ * Add to 3CX call log
21150
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
21151
+ * @param {*} [options] Override http request option.
21152
+ * @throws {RequiredError}
21153
+ */
21154
+ async postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21155
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postAddCallLog(tcxCallLogEntity, options);
21156
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21157
+ const localVarOperationServerBasePath = operationServerMap['Class3CXApi.postAddCallLog']?.[localVarOperationServerIndex]?.url;
21158
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21159
+ },
21073
21160
  /**
21074
21161
  * Get 3CX service principals
21075
21162
  * @param {string} id Instance ID
@@ -21166,6 +21253,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
21166
21253
  getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>> {
21167
21254
  return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
21168
21255
  },
21256
+ /**
21257
+ * Add to 3CX call log
21258
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
21259
+ * @param {*} [options] Override http request option.
21260
+ * @throws {RequiredError}
21261
+ */
21262
+ postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21263
+ return localVarFp.postAddCallLog(tcxCallLogEntity, options).then((request) => request(axios, basePath));
21264
+ },
21169
21265
  /**
21170
21266
  * Get 3CX service principals
21171
21267
  * @param {string} id Instance ID
@@ -21261,6 +21357,16 @@ export class Class3CXApi extends BaseAPI {
21261
21357
  return Class3CXApiFp(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
21262
21358
  }
21263
21359
 
21360
+ /**
21361
+ * Add to 3CX call log
21362
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
21363
+ * @param {*} [options] Override http request option.
21364
+ * @throws {RequiredError}
21365
+ */
21366
+ public postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig) {
21367
+ return Class3CXApiFp(this.configuration).postAddCallLog(tcxCallLogEntity, options).then((request) => request(this.axios, this.basePath));
21368
+ }
21369
+
21264
21370
  /**
21265
21371
  * Get 3CX service principals
21266
21372
  * @param {string} id Instance ID
package/dist/api.d.ts CHANGED
@@ -1318,6 +1318,7 @@ export declare const AuditLogEntityTypeEnum: {
1318
1318
  readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
1319
1319
  readonly Pops3cxUsers: "pops_3cx_users";
1320
1320
  readonly _3cxServicePrincipals: "3cx_service_principals";
1321
+ readonly _3cxCallLog: "3cx_call_log";
1321
1322
  readonly PopsUsers: "pops_users";
1322
1323
  readonly PopsVideoRequests: "pops_video_requests";
1323
1324
  readonly Webhook: "webhook";
@@ -9778,6 +9779,39 @@ export interface TcxBulkLicenceDetailsModel {
9778
9779
  */
9779
9780
  'errors': Array<TcxLicenceDetailsErrorModel>;
9780
9781
  }
9782
+ /**
9783
+ * TcxCallLogEntity
9784
+ */
9785
+ export interface TcxCallLogEntity {
9786
+ /**
9787
+ * instanceId
9788
+ */
9789
+ 'instanceId': string;
9790
+ /**
9791
+ * callId
9792
+ */
9793
+ 'callId': number;
9794
+ /**
9795
+ * number
9796
+ */
9797
+ 'number': string;
9798
+ /**
9799
+ * dn
9800
+ */
9801
+ 'dn': string;
9802
+ /**
9803
+ * device
9804
+ */
9805
+ 'device': string;
9806
+ /**
9807
+ * startedAt
9808
+ */
9809
+ 'startedAt': string;
9810
+ /**
9811
+ * endedAt
9812
+ */
9813
+ 'endedAt': string;
9814
+ }
9781
9815
  /**
9782
9816
  * DeadLicencesEntity
9783
9817
  */
@@ -15337,10 +15371,11 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
15337
15371
  getGetCrmActivities: (id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15338
15372
  /**
15339
15373
  * Search for contacts by phone number
15374
+ * @param {string} phone Phone Number
15340
15375
  * @param {*} [options] Override http request option.
15341
15376
  * @throws {RequiredError}
15342
15377
  */
15343
- getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15378
+ getSearchByPhone: (phone: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15344
15379
  /**
15345
15380
  * Create CRM Note
15346
15381
  * @param {number} id Account ID
@@ -15373,10 +15408,11 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
15373
15408
  getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDTO>>;
15374
15409
  /**
15375
15410
  * Search for contacts by phone number
15411
+ * @param {string} phone Phone Number
15376
15412
  * @param {*} [options] Override http request option.
15377
15413
  * @throws {RequiredError}
15378
15414
  */
15379
- getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
15415
+ getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
15380
15416
  /**
15381
15417
  * Create CRM Note
15382
15418
  * @param {number} id Account ID
@@ -15409,10 +15445,11 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
15409
15445
  getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDTO>;
15410
15446
  /**
15411
15447
  * Search for contacts by phone number
15448
+ * @param {string} phone Phone Number
15412
15449
  * @param {*} [options] Override http request option.
15413
15450
  * @throws {RequiredError}
15414
15451
  */
15415
- getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
15452
+ getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
15416
15453
  /**
15417
15454
  * Create CRM Note
15418
15455
  * @param {number} id Account ID
@@ -15445,10 +15482,11 @@ export declare class CRMApi extends BaseAPI {
15445
15482
  getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivitiesResponseDTO, any, {}, any>>;
15446
15483
  /**
15447
15484
  * Search for contacts by phone number
15485
+ * @param {string} phone Phone Number
15448
15486
  * @param {*} [options] Override http request option.
15449
15487
  * @throws {RequiredError}
15450
15488
  */
15451
- getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}, any>>;
15489
+ getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}, any>>;
15452
15490
  /**
15453
15491
  * Create CRM Note
15454
15492
  * @param {number} id Account ID
@@ -15528,6 +15566,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
15528
15566
  * @throws {RequiredError}
15529
15567
  */
15530
15568
  getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15569
+ /**
15570
+ * Add to 3CX call log
15571
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
15572
+ * @param {*} [options] Override http request option.
15573
+ * @throws {RequiredError}
15574
+ */
15575
+ postAddCallLog: (tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15531
15576
  /**
15532
15577
  * Get 3CX service principals
15533
15578
  * @param {string} id Instance ID
@@ -15596,6 +15641,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
15596
15641
  * @throws {RequiredError}
15597
15642
  */
15598
15643
  getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
15644
+ /**
15645
+ * Add to 3CX call log
15646
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
15647
+ * @param {*} [options] Override http request option.
15648
+ * @throws {RequiredError}
15649
+ */
15650
+ postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15599
15651
  /**
15600
15652
  * Get 3CX service principals
15601
15653
  * @param {string} id Instance ID
@@ -15664,6 +15716,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
15664
15716
  * @throws {RequiredError}
15665
15717
  */
15666
15718
  getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
15719
+ /**
15720
+ * Add to 3CX call log
15721
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
15722
+ * @param {*} [options] Override http request option.
15723
+ * @throws {RequiredError}
15724
+ */
15725
+ postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15667
15726
  /**
15668
15727
  * Get 3CX service principals
15669
15728
  * @param {string} id Instance ID
@@ -15732,6 +15791,13 @@ export declare class Class3CXApi extends BaseAPI {
15732
15791
  * @throws {RequiredError}
15733
15792
  */
15734
15793
  getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDTO[], any, {}, any>>;
15794
+ /**
15795
+ * Add to 3CX call log
15796
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
15797
+ * @param {*} [options] Override http request option.
15798
+ * @throws {RequiredError}
15799
+ */
15800
+ postAddCallLog(tcxCallLogEntity?: TcxCallLogEntity, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
15735
15801
  /**
15736
15802
  * Get 3CX service principals
15737
15803
  * @param {string} id Instance ID
package/dist/api.js CHANGED
@@ -242,6 +242,7 @@ exports.AuditLogEntityTypeEnum = {
242
242
  Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
243
243
  Pops3cxUsers: 'pops_3cx_users',
244
244
  _3cxServicePrincipals: '3cx_service_principals',
245
+ _3cxCallLog: '3cx_call_log',
245
246
  PopsUsers: 'pops_users',
246
247
  PopsVideoRequests: 'pops_video_requests',
247
248
  Webhook: 'webhook',
@@ -11316,18 +11317,21 @@ var CRMApiAxiosParamCreator = function (configuration) {
11316
11317
  },
11317
11318
  /**
11318
11319
  * Search for contacts by phone number
11320
+ * @param {string} phone Phone Number
11319
11321
  * @param {*} [options] Override http request option.
11320
11322
  * @throws {RequiredError}
11321
11323
  */
11322
- getSearchByPhone: function () {
11324
+ getSearchByPhone: function (phone_1) {
11323
11325
  var args_1 = [];
11324
- for (var _i = 0; _i < arguments.length; _i++) {
11325
- args_1[_i] = arguments[_i];
11326
+ for (var _i = 1; _i < arguments.length; _i++) {
11327
+ args_1[_i - 1] = arguments[_i];
11326
11328
  }
11327
- return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
11329
+ return __awaiter(_this, __spreadArray([phone_1], args_1, true), void 0, function (phone, options) {
11328
11330
  var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
11329
11331
  if (options === void 0) { options = {}; }
11330
11332
  return __generator(this, function (_a) {
11333
+ // verify required parameter 'phone' is not null or undefined
11334
+ (0, common_1.assertParamExists)('getSearchByPhone', 'phone', phone);
11331
11335
  localVarPath = "/crm/contact/search";
11332
11336
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
11333
11337
  if (configuration) {
@@ -11336,6 +11340,9 @@ var CRMApiAxiosParamCreator = function (configuration) {
11336
11340
  localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
11337
11341
  localVarHeaderParameter = {};
11338
11342
  localVarQueryParameter = {};
11343
+ if (phone !== undefined) {
11344
+ localVarQueryParameter['phone'] = phone;
11345
+ }
11339
11346
  localVarHeaderParameter['Accept'] = 'application/json';
11340
11347
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
11341
11348
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -11462,16 +11469,17 @@ var CRMApiFp = function (configuration) {
11462
11469
  },
11463
11470
  /**
11464
11471
  * Search for contacts by phone number
11472
+ * @param {string} phone Phone Number
11465
11473
  * @param {*} [options] Override http request option.
11466
11474
  * @throws {RequiredError}
11467
11475
  */
11468
- getSearchByPhone: function (options) {
11476
+ getSearchByPhone: function (phone, options) {
11469
11477
  return __awaiter(this, void 0, void 0, function () {
11470
11478
  var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
11471
11479
  var _a, _b, _c;
11472
11480
  return __generator(this, function (_d) {
11473
11481
  switch (_d.label) {
11474
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(options)];
11482
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(phone, options)];
11475
11483
  case 1:
11476
11484
  localVarAxiosArgs = _d.sent();
11477
11485
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -11549,11 +11557,12 @@ var CRMApiFactory = function (configuration, basePath, axios) {
11549
11557
  },
11550
11558
  /**
11551
11559
  * Search for contacts by phone number
11560
+ * @param {string} phone Phone Number
11552
11561
  * @param {*} [options] Override http request option.
11553
11562
  * @throws {RequiredError}
11554
11563
  */
11555
- getSearchByPhone: function (options) {
11556
- return localVarFp.getSearchByPhone(options).then(function (request) { return request(axios, basePath); });
11564
+ getSearchByPhone: function (phone, options) {
11565
+ return localVarFp.getSearchByPhone(phone, options).then(function (request) { return request(axios, basePath); });
11557
11566
  },
11558
11567
  /**
11559
11568
  * Create CRM Note
@@ -11600,12 +11609,13 @@ var CRMApi = /** @class */ (function (_super) {
11600
11609
  };
11601
11610
  /**
11602
11611
  * Search for contacts by phone number
11612
+ * @param {string} phone Phone Number
11603
11613
  * @param {*} [options] Override http request option.
11604
11614
  * @throws {RequiredError}
11605
11615
  */
11606
- CRMApi.prototype.getSearchByPhone = function (options) {
11616
+ CRMApi.prototype.getSearchByPhone = function (phone, options) {
11607
11617
  var _this = this;
11608
- return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
11618
+ return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(phone, options).then(function (request) { return request(_this.axios, _this.basePath); });
11609
11619
  };
11610
11620
  /**
11611
11621
  * Create CRM Note
@@ -11889,6 +11899,41 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
11889
11899
  });
11890
11900
  });
11891
11901
  },
11902
+ /**
11903
+ * Add to 3CX call log
11904
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
11905
+ * @param {*} [options] Override http request option.
11906
+ * @throws {RequiredError}
11907
+ */
11908
+ postAddCallLog: function (tcxCallLogEntity_1) {
11909
+ var args_1 = [];
11910
+ for (var _i = 1; _i < arguments.length; _i++) {
11911
+ args_1[_i - 1] = arguments[_i];
11912
+ }
11913
+ return __awaiter(_this, __spreadArray([tcxCallLogEntity_1], args_1, true), void 0, function (tcxCallLogEntity, options) {
11914
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
11915
+ if (options === void 0) { options = {}; }
11916
+ return __generator(this, function (_a) {
11917
+ localVarPath = "/tcx/cc/call/log";
11918
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
11919
+ if (configuration) {
11920
+ baseOptions = configuration.baseOptions;
11921
+ }
11922
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
11923
+ localVarHeaderParameter = {};
11924
+ localVarQueryParameter = {};
11925
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11926
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
11927
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11928
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11929
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(tcxCallLogEntity, localVarRequestOptions, configuration);
11930
+ return [2 /*return*/, {
11931
+ url: (0, common_1.toPathString)(localVarUrlObj),
11932
+ options: localVarRequestOptions,
11933
+ }];
11934
+ });
11935
+ });
11936
+ },
11892
11937
  /**
11893
11938
  * Get 3CX service principals
11894
11939
  * @param {string} id Instance ID
@@ -12124,6 +12169,28 @@ var Class3CXApiFp = function (configuration) {
12124
12169
  });
12125
12170
  });
12126
12171
  },
12172
+ /**
12173
+ * Add to 3CX call log
12174
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
12175
+ * @param {*} [options] Override http request option.
12176
+ * @throws {RequiredError}
12177
+ */
12178
+ postAddCallLog: function (tcxCallLogEntity, options) {
12179
+ return __awaiter(this, void 0, void 0, function () {
12180
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
12181
+ var _a, _b, _c;
12182
+ return __generator(this, function (_d) {
12183
+ switch (_d.label) {
12184
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddCallLog(tcxCallLogEntity, options)];
12185
+ case 1:
12186
+ localVarAxiosArgs = _d.sent();
12187
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
12188
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.postAddCallLog']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
12189
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
12190
+ }
12191
+ });
12192
+ });
12193
+ },
12127
12194
  /**
12128
12195
  * Get 3CX service principals
12129
12196
  * @param {string} id Instance ID
@@ -12240,6 +12307,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
12240
12307
  getGetTcxPartners: function (options) {
12241
12308
  return localVarFp.getGetTcxPartners(options).then(function (request) { return request(axios, basePath); });
12242
12309
  },
12310
+ /**
12311
+ * Add to 3CX call log
12312
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
12313
+ * @param {*} [options] Override http request option.
12314
+ * @throws {RequiredError}
12315
+ */
12316
+ postAddCallLog: function (tcxCallLogEntity, options) {
12317
+ return localVarFp.postAddCallLog(tcxCallLogEntity, options).then(function (request) { return request(axios, basePath); });
12318
+ },
12243
12319
  /**
12244
12320
  * Get 3CX service principals
12245
12321
  * @param {string} id Instance ID
@@ -12339,6 +12415,16 @@ var Class3CXApi = /** @class */ (function (_super) {
12339
12415
  var _this = this;
12340
12416
  return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then(function (request) { return request(_this.axios, _this.basePath); });
12341
12417
  };
12418
+ /**
12419
+ * Add to 3CX call log
12420
+ * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
12421
+ * @param {*} [options] Override http request option.
12422
+ * @throws {RequiredError}
12423
+ */
12424
+ Class3CXApi.prototype.postAddCallLog = function (tcxCallLogEntity, options) {
12425
+ var _this = this;
12426
+ return (0, exports.Class3CXApiFp)(this.configuration).postAddCallLog(tcxCallLogEntity, options).then(function (request) { return request(_this.axios, _this.basePath); });
12427
+ };
12342
12428
  /**
12343
12429
  * Get 3CX service principals
12344
12430
  * @param {string} id Instance ID
package/docs/CRMApi.md CHANGED
@@ -85,11 +85,18 @@ import {
85
85
  const configuration = new Configuration();
86
86
  const apiInstance = new CRMApi(configuration);
87
87
 
88
- const { status, data } = await apiInstance.getSearchByPhone();
88
+ let phone: string; //Phone Number (default to undefined)
89
+
90
+ const { status, data } = await apiInstance.getSearchByPhone(
91
+ phone
92
+ );
89
93
  ```
90
94
 
91
95
  ### Parameters
92
- This endpoint does not have any parameters.
96
+
97
+ |Name | Type | Description | Notes|
98
+ |------------- | ------------- | ------------- | -------------|
99
+ | **phone** | [**string**] | Phone Number | defaults to undefined|
93
100
 
94
101
 
95
102
  ### Return type
@@ -11,6 +11,7 @@ All URIs are relative to *https://bitbucket.org*
11
11
  |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
12
12
  |[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
13
13
  |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
14
+ |[**postAddCallLog**](#postaddcalllog) | **POST** /tcx/cc/call/log | |
14
15
  |[**postAuthenticateInstanceWebsocket**](#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} | |
15
16
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
16
17
 
@@ -350,6 +351,61 @@ No authorization required
350
351
 
351
352
  [[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)
352
353
 
354
+ # **postAddCallLog**
355
+ > postAddCallLog()
356
+
357
+ Add to 3CX call log
358
+
359
+ ### Example
360
+
361
+ ```typescript
362
+ import {
363
+ Class3CXApi,
364
+ Configuration,
365
+ TcxCallLogEntity
366
+ } from 'yellowgrid-api-ts';
367
+
368
+ const configuration = new Configuration();
369
+ const apiInstance = new Class3CXApi(configuration);
370
+
371
+ let tcxCallLogEntity: TcxCallLogEntity; //Call Log (optional)
372
+
373
+ const { status, data } = await apiInstance.postAddCallLog(
374
+ tcxCallLogEntity
375
+ );
376
+ ```
377
+
378
+ ### Parameters
379
+
380
+ |Name | Type | Description | Notes|
381
+ |------------- | ------------- | ------------- | -------------|
382
+ | **tcxCallLogEntity** | **TcxCallLogEntity**| Call Log | |
383
+
384
+
385
+ ### Return type
386
+
387
+ void (empty response body)
388
+
389
+ ### Authorization
390
+
391
+ No authorization required
392
+
393
+ ### HTTP request headers
394
+
395
+ - **Content-Type**: application/json
396
+ - **Accept**: Not defined
397
+
398
+
399
+ ### HTTP response details
400
+ | Status code | Description | Response headers |
401
+ |-------------|-------------|------------------|
402
+ |**204** | No Response | - |
403
+ |**400** | Bad Request | - |
404
+ |**401** | Unauthorised | - |
405
+ |**403** | Access Denied | - |
406
+
407
+ [[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)
408
+
353
409
  # **postAuthenticateInstanceWebsocket**
354
410
  > postAuthenticateInstanceWebsocket()
355
411
 
@@ -0,0 +1,33 @@
1
+ # TcxCallLogEntity
2
+
3
+ TcxCallLogEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **instanceId** | **string** | instanceId | [default to undefined]
10
+ **callId** | **number** | callId | [default to undefined]
11
+ **number** | **string** | number | [default to undefined]
12
+ **dn** | **string** | dn | [default to undefined]
13
+ **device** | **string** | device | [default to undefined]
14
+ **startedAt** | **string** | startedAt | [default to undefined]
15
+ **endedAt** | **string** | endedAt | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { TcxCallLogEntity } from 'yellowgrid-api-ts';
21
+
22
+ const instance: TcxCallLogEntity = {
23
+ instanceId,
24
+ callId,
25
+ number,
26
+ dn,
27
+ device,
28
+ startedAt,
29
+ endedAt,
30
+ };
31
+ ```
32
+
33
+ [[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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.346",
3
+ "version": "3.2.348",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {