yellowgrid-api-ts 3.2.345 → 3.2.347
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.
- package/README.md +2 -0
- package/api.ts +137 -7
- package/dist/api.d.ts +60 -4
- package/dist/api.js +167 -10
- package/docs/CRMApi.md +9 -2
- package/docs/Class3CXApi.md +103 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -183,10 +183,12 @@ Class | Method | HTTP request | Description
|
|
|
183
183
|
*CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal |
|
|
184
184
|
*Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices |
|
|
185
185
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
186
|
+
*Class3CXApi* | [**getGetServicePrincipals**](docs/Class3CXApi.md#getgetserviceprincipals) | **GET** /tcx/cc/services |
|
|
186
187
|
*Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
|
|
187
188
|
*Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
|
|
188
189
|
*Class3CXApi* | [**getGetTcxExpiringKeysCsv**](docs/Class3CXApi.md#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
|
|
189
190
|
*Class3CXApi* | [**getGetTcxPartners**](docs/Class3CXApi.md#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners
|
|
191
|
+
*Class3CXApi* | [**postAuthenticateInstanceWebsocket**](docs/Class3CXApi.md#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} |
|
|
190
192
|
*Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
|
|
191
193
|
*Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
|
|
192
194
|
*Class3CXInstallationWizardApi* | [**deleteAddNumbers**](docs/Class3CXInstallationWizardApi.md#deleteaddnumbers) | **DELETE** /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers
|
package/api.ts
CHANGED
|
@@ -20423,10 +20423,13 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
20423
20423
|
},
|
|
20424
20424
|
/**
|
|
20425
20425
|
* Search for contacts by phone number
|
|
20426
|
+
* @param {string} phone Phone Number
|
|
20426
20427
|
* @param {*} [options] Override http request option.
|
|
20427
20428
|
* @throws {RequiredError}
|
|
20428
20429
|
*/
|
|
20429
|
-
getSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20430
|
+
getSearchByPhone: async (phone: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20431
|
+
// verify required parameter 'phone' is not null or undefined
|
|
20432
|
+
assertParamExists('getSearchByPhone', 'phone', phone)
|
|
20430
20433
|
const localVarPath = `/crm/contact/search`;
|
|
20431
20434
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20432
20435
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -20439,6 +20442,10 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
20439
20442
|
const localVarHeaderParameter = {} as any;
|
|
20440
20443
|
const localVarQueryParameter = {} as any;
|
|
20441
20444
|
|
|
20445
|
+
if (phone !== undefined) {
|
|
20446
|
+
localVarQueryParameter['phone'] = phone;
|
|
20447
|
+
}
|
|
20448
|
+
|
|
20442
20449
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20443
20450
|
|
|
20444
20451
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -20547,11 +20554,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
20547
20554
|
},
|
|
20548
20555
|
/**
|
|
20549
20556
|
* Search for contacts by phone number
|
|
20557
|
+
* @param {string} phone Phone Number
|
|
20550
20558
|
* @param {*} [options] Override http request option.
|
|
20551
20559
|
* @throws {RequiredError}
|
|
20552
20560
|
*/
|
|
20553
|
-
async getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
|
|
20554
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(options);
|
|
20561
|
+
async getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
|
|
20562
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(phone, options);
|
|
20555
20563
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20556
20564
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.getSearchByPhone']?.[localVarOperationServerIndex]?.url;
|
|
20557
20565
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -20604,11 +20612,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
20604
20612
|
},
|
|
20605
20613
|
/**
|
|
20606
20614
|
* Search for contacts by phone number
|
|
20615
|
+
* @param {string} phone Phone Number
|
|
20607
20616
|
* @param {*} [options] Override http request option.
|
|
20608
20617
|
* @throws {RequiredError}
|
|
20609
20618
|
*/
|
|
20610
|
-
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
|
|
20611
|
-
return localVarFp.getSearchByPhone(options).then((request) => request(axios, basePath));
|
|
20619
|
+
getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
|
|
20620
|
+
return localVarFp.getSearchByPhone(phone, options).then((request) => request(axios, basePath));
|
|
20612
20621
|
},
|
|
20613
20622
|
/**
|
|
20614
20623
|
* Create CRM Note
|
|
@@ -20651,11 +20660,12 @@ export class CRMApi extends BaseAPI {
|
|
|
20651
20660
|
|
|
20652
20661
|
/**
|
|
20653
20662
|
* Search for contacts by phone number
|
|
20663
|
+
* @param {string} phone Phone Number
|
|
20654
20664
|
* @param {*} [options] Override http request option.
|
|
20655
20665
|
* @throws {RequiredError}
|
|
20656
20666
|
*/
|
|
20657
|
-
public getSearchByPhone(options?: RawAxiosRequestConfig) {
|
|
20658
|
-
return CRMApiFp(this.configuration).getSearchByPhone(options).then((request) => request(this.axios, this.basePath));
|
|
20667
|
+
public getSearchByPhone(phone: string, options?: RawAxiosRequestConfig) {
|
|
20668
|
+
return CRMApiFp(this.configuration).getSearchByPhone(phone, options).then((request) => request(this.axios, this.basePath));
|
|
20659
20669
|
}
|
|
20660
20670
|
|
|
20661
20671
|
/**
|
|
@@ -20764,6 +20774,35 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
20764
20774
|
options: localVarRequestOptions,
|
|
20765
20775
|
};
|
|
20766
20776
|
},
|
|
20777
|
+
/**
|
|
20778
|
+
* Get 3CX service principals
|
|
20779
|
+
* @param {*} [options] Override http request option.
|
|
20780
|
+
* @throws {RequiredError}
|
|
20781
|
+
*/
|
|
20782
|
+
getGetServicePrincipals: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20783
|
+
const localVarPath = `/tcx/cc/services`;
|
|
20784
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20785
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20786
|
+
let baseOptions;
|
|
20787
|
+
if (configuration) {
|
|
20788
|
+
baseOptions = configuration.baseOptions;
|
|
20789
|
+
}
|
|
20790
|
+
|
|
20791
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20792
|
+
const localVarHeaderParameter = {} as any;
|
|
20793
|
+
const localVarQueryParameter = {} as any;
|
|
20794
|
+
|
|
20795
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20796
|
+
|
|
20797
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20798
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20799
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20800
|
+
|
|
20801
|
+
return {
|
|
20802
|
+
url: toPathString(localVarUrlObj),
|
|
20803
|
+
options: localVarRequestOptions,
|
|
20804
|
+
};
|
|
20805
|
+
},
|
|
20767
20806
|
/**
|
|
20768
20807
|
* Get 3CX Credit Status
|
|
20769
20808
|
* @summary Get 3CX Credit Status
|
|
@@ -20875,6 +20914,38 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
20875
20914
|
|
|
20876
20915
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20877
20916
|
|
|
20917
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20918
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20919
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20920
|
+
|
|
20921
|
+
return {
|
|
20922
|
+
url: toPathString(localVarUrlObj),
|
|
20923
|
+
options: localVarRequestOptions,
|
|
20924
|
+
};
|
|
20925
|
+
},
|
|
20926
|
+
/**
|
|
20927
|
+
* Get 3CX service principals
|
|
20928
|
+
* @param {string} id Instance ID
|
|
20929
|
+
* @param {*} [options] Override http request option.
|
|
20930
|
+
* @throws {RequiredError}
|
|
20931
|
+
*/
|
|
20932
|
+
postAuthenticateInstanceWebsocket: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20933
|
+
// verify required parameter 'id' is not null or undefined
|
|
20934
|
+
assertParamExists('postAuthenticateInstanceWebsocket', 'id', id)
|
|
20935
|
+
const localVarPath = `/tcx/cc/instance/auth/{id}`
|
|
20936
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
20937
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20938
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20939
|
+
let baseOptions;
|
|
20940
|
+
if (configuration) {
|
|
20941
|
+
baseOptions = configuration.baseOptions;
|
|
20942
|
+
}
|
|
20943
|
+
|
|
20944
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
20945
|
+
const localVarHeaderParameter = {} as any;
|
|
20946
|
+
const localVarQueryParameter = {} as any;
|
|
20947
|
+
|
|
20948
|
+
|
|
20878
20949
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20879
20950
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20880
20951
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -20950,6 +21021,17 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
|
20950
21021
|
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetLicenceDetails']?.[localVarOperationServerIndex]?.url;
|
|
20951
21022
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20952
21023
|
},
|
|
21024
|
+
/**
|
|
21025
|
+
* Get 3CX service principals
|
|
21026
|
+
* @param {*} [options] Override http request option.
|
|
21027
|
+
* @throws {RequiredError}
|
|
21028
|
+
*/
|
|
21029
|
+
async getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>> {
|
|
21030
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetServicePrincipals(options);
|
|
21031
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21032
|
+
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetServicePrincipals']?.[localVarOperationServerIndex]?.url;
|
|
21033
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21034
|
+
},
|
|
20953
21035
|
/**
|
|
20954
21036
|
* Get 3CX Credit Status
|
|
20955
21037
|
* @summary Get 3CX Credit Status
|
|
@@ -20998,6 +21080,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
|
20998
21080
|
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
|
|
20999
21081
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21000
21082
|
},
|
|
21083
|
+
/**
|
|
21084
|
+
* Get 3CX service principals
|
|
21085
|
+
* @param {string} id Instance ID
|
|
21086
|
+
* @param {*} [options] Override http request option.
|
|
21087
|
+
* @throws {RequiredError}
|
|
21088
|
+
*/
|
|
21089
|
+
async postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
21090
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAuthenticateInstanceWebsocket(id, options);
|
|
21091
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21092
|
+
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.postAuthenticateInstanceWebsocket']?.[localVarOperationServerIndex]?.url;
|
|
21093
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21094
|
+
},
|
|
21001
21095
|
/**
|
|
21002
21096
|
* Get Bulk 3CX Licence Details
|
|
21003
21097
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -21038,6 +21132,14 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
|
|
|
21038
21132
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel> {
|
|
21039
21133
|
return localVarFp.getGetLicenceDetails(key, options).then((request) => request(axios, basePath));
|
|
21040
21134
|
},
|
|
21135
|
+
/**
|
|
21136
|
+
* Get 3CX service principals
|
|
21137
|
+
* @param {*} [options] Override http request option.
|
|
21138
|
+
* @throws {RequiredError}
|
|
21139
|
+
*/
|
|
21140
|
+
getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>> {
|
|
21141
|
+
return localVarFp.getGetServicePrincipals(options).then((request) => request(axios, basePath));
|
|
21142
|
+
},
|
|
21041
21143
|
/**
|
|
21042
21144
|
* Get 3CX Credit Status
|
|
21043
21145
|
* @summary Get 3CX Credit Status
|
|
@@ -21074,6 +21176,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
|
|
|
21074
21176
|
getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>> {
|
|
21075
21177
|
return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
|
|
21076
21178
|
},
|
|
21179
|
+
/**
|
|
21180
|
+
* Get 3CX service principals
|
|
21181
|
+
* @param {string} id Instance ID
|
|
21182
|
+
* @param {*} [options] Override http request option.
|
|
21183
|
+
* @throws {RequiredError}
|
|
21184
|
+
*/
|
|
21185
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
21186
|
+
return localVarFp.postAuthenticateInstanceWebsocket(id, options).then((request) => request(axios, basePath));
|
|
21187
|
+
},
|
|
21077
21188
|
/**
|
|
21078
21189
|
* Get Bulk 3CX Licence Details
|
|
21079
21190
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -21111,6 +21222,15 @@ export class Class3CXApi extends BaseAPI {
|
|
|
21111
21222
|
return Class3CXApiFp(this.configuration).getGetLicenceDetails(key, options).then((request) => request(this.axios, this.basePath));
|
|
21112
21223
|
}
|
|
21113
21224
|
|
|
21225
|
+
/**
|
|
21226
|
+
* Get 3CX service principals
|
|
21227
|
+
* @param {*} [options] Override http request option.
|
|
21228
|
+
* @throws {RequiredError}
|
|
21229
|
+
*/
|
|
21230
|
+
public getGetServicePrincipals(options?: RawAxiosRequestConfig) {
|
|
21231
|
+
return Class3CXApiFp(this.configuration).getGetServicePrincipals(options).then((request) => request(this.axios, this.basePath));
|
|
21232
|
+
}
|
|
21233
|
+
|
|
21114
21234
|
/**
|
|
21115
21235
|
* Get 3CX Credit Status
|
|
21116
21236
|
* @summary Get 3CX Credit Status
|
|
@@ -21151,6 +21271,16 @@ export class Class3CXApi extends BaseAPI {
|
|
|
21151
21271
|
return Class3CXApiFp(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
|
|
21152
21272
|
}
|
|
21153
21273
|
|
|
21274
|
+
/**
|
|
21275
|
+
* Get 3CX service principals
|
|
21276
|
+
* @param {string} id Instance ID
|
|
21277
|
+
* @param {*} [options] Override http request option.
|
|
21278
|
+
* @throws {RequiredError}
|
|
21279
|
+
*/
|
|
21280
|
+
public postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig) {
|
|
21281
|
+
return Class3CXApiFp(this.configuration).postAuthenticateInstanceWebsocket(id, options).then((request) => request(this.axios, this.basePath));
|
|
21282
|
+
}
|
|
21283
|
+
|
|
21154
21284
|
/**
|
|
21155
21285
|
* Get Bulk 3CX Licence Details
|
|
21156
21286
|
* @summary Get bulk 3CX Licence Details
|
package/dist/api.d.ts
CHANGED
|
@@ -15337,10 +15337,11 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
15337
15337
|
getGetCrmActivities: (id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15338
15338
|
/**
|
|
15339
15339
|
* Search for contacts by phone number
|
|
15340
|
+
* @param {string} phone Phone Number
|
|
15340
15341
|
* @param {*} [options] Override http request option.
|
|
15341
15342
|
* @throws {RequiredError}
|
|
15342
15343
|
*/
|
|
15343
|
-
getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15344
|
+
getSearchByPhone: (phone: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15344
15345
|
/**
|
|
15345
15346
|
* Create CRM Note
|
|
15346
15347
|
* @param {number} id Account ID
|
|
@@ -15373,10 +15374,11 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
15373
15374
|
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDTO>>;
|
|
15374
15375
|
/**
|
|
15375
15376
|
* Search for contacts by phone number
|
|
15377
|
+
* @param {string} phone Phone Number
|
|
15376
15378
|
* @param {*} [options] Override http request option.
|
|
15377
15379
|
* @throws {RequiredError}
|
|
15378
15380
|
*/
|
|
15379
|
-
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
|
|
15381
|
+
getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
|
|
15380
15382
|
/**
|
|
15381
15383
|
* Create CRM Note
|
|
15382
15384
|
* @param {number} id Account ID
|
|
@@ -15409,10 +15411,11 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
15409
15411
|
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDTO>;
|
|
15410
15412
|
/**
|
|
15411
15413
|
* Search for contacts by phone number
|
|
15414
|
+
* @param {string} phone Phone Number
|
|
15412
15415
|
* @param {*} [options] Override http request option.
|
|
15413
15416
|
* @throws {RequiredError}
|
|
15414
15417
|
*/
|
|
15415
|
-
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
|
|
15418
|
+
getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
|
|
15416
15419
|
/**
|
|
15417
15420
|
* Create CRM Note
|
|
15418
15421
|
* @param {number} id Account ID
|
|
@@ -15445,10 +15448,11 @@ export declare class CRMApi extends BaseAPI {
|
|
|
15445
15448
|
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivitiesResponseDTO, any, {}, any>>;
|
|
15446
15449
|
/**
|
|
15447
15450
|
* Search for contacts by phone number
|
|
15451
|
+
* @param {string} phone Phone Number
|
|
15448
15452
|
* @param {*} [options] Override http request option.
|
|
15449
15453
|
* @throws {RequiredError}
|
|
15450
15454
|
*/
|
|
15451
|
-
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}, any>>;
|
|
15455
|
+
getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}, any>>;
|
|
15452
15456
|
/**
|
|
15453
15457
|
* Create CRM Note
|
|
15454
15458
|
* @param {number} id Account ID
|
|
@@ -15494,6 +15498,12 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
15494
15498
|
* @throws {RequiredError}
|
|
15495
15499
|
*/
|
|
15496
15500
|
getGetLicenceDetails: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15501
|
+
/**
|
|
15502
|
+
* Get 3CX service principals
|
|
15503
|
+
* @param {*} [options] Override http request option.
|
|
15504
|
+
* @throws {RequiredError}
|
|
15505
|
+
*/
|
|
15506
|
+
getGetServicePrincipals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15497
15507
|
/**
|
|
15498
15508
|
* Get 3CX Credit Status
|
|
15499
15509
|
* @summary Get 3CX Credit Status
|
|
@@ -15522,6 +15532,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
15522
15532
|
* @throws {RequiredError}
|
|
15523
15533
|
*/
|
|
15524
15534
|
getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15535
|
+
/**
|
|
15536
|
+
* Get 3CX service principals
|
|
15537
|
+
* @param {string} id Instance ID
|
|
15538
|
+
* @param {*} [options] Override http request option.
|
|
15539
|
+
* @throws {RequiredError}
|
|
15540
|
+
*/
|
|
15541
|
+
postAuthenticateInstanceWebsocket: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15525
15542
|
/**
|
|
15526
15543
|
* Get Bulk 3CX Licence Details
|
|
15527
15544
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -15549,6 +15566,12 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
|
15549
15566
|
* @throws {RequiredError}
|
|
15550
15567
|
*/
|
|
15551
15568
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxLicenceDetailsModel>>;
|
|
15569
|
+
/**
|
|
15570
|
+
* Get 3CX service principals
|
|
15571
|
+
* @param {*} [options] Override http request option.
|
|
15572
|
+
* @throws {RequiredError}
|
|
15573
|
+
*/
|
|
15574
|
+
getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>>;
|
|
15552
15575
|
/**
|
|
15553
15576
|
* Get 3CX Credit Status
|
|
15554
15577
|
* @summary Get 3CX Credit Status
|
|
@@ -15577,6 +15600,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
|
15577
15600
|
* @throws {RequiredError}
|
|
15578
15601
|
*/
|
|
15579
15602
|
getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
|
|
15603
|
+
/**
|
|
15604
|
+
* Get 3CX service principals
|
|
15605
|
+
* @param {string} id Instance ID
|
|
15606
|
+
* @param {*} [options] Override http request option.
|
|
15607
|
+
* @throws {RequiredError}
|
|
15608
|
+
*/
|
|
15609
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15580
15610
|
/**
|
|
15581
15611
|
* Get Bulk 3CX Licence Details
|
|
15582
15612
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -15604,6 +15634,12 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
|
|
|
15604
15634
|
* @throws {RequiredError}
|
|
15605
15635
|
*/
|
|
15606
15636
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel>;
|
|
15637
|
+
/**
|
|
15638
|
+
* Get 3CX service principals
|
|
15639
|
+
* @param {*} [options] Override http request option.
|
|
15640
|
+
* @throws {RequiredError}
|
|
15641
|
+
*/
|
|
15642
|
+
getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>>;
|
|
15607
15643
|
/**
|
|
15608
15644
|
* Get 3CX Credit Status
|
|
15609
15645
|
* @summary Get 3CX Credit Status
|
|
@@ -15632,6 +15668,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
|
|
|
15632
15668
|
* @throws {RequiredError}
|
|
15633
15669
|
*/
|
|
15634
15670
|
getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
|
|
15671
|
+
/**
|
|
15672
|
+
* Get 3CX service principals
|
|
15673
|
+
* @param {string} id Instance ID
|
|
15674
|
+
* @param {*} [options] Override http request option.
|
|
15675
|
+
* @throws {RequiredError}
|
|
15676
|
+
*/
|
|
15677
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15635
15678
|
/**
|
|
15636
15679
|
* Get Bulk 3CX Licence Details
|
|
15637
15680
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -15659,6 +15702,12 @@ export declare class Class3CXApi extends BaseAPI {
|
|
|
15659
15702
|
* @throws {RequiredError}
|
|
15660
15703
|
*/
|
|
15661
15704
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxLicenceDetailsModel, any, {}, any>>;
|
|
15705
|
+
/**
|
|
15706
|
+
* Get 3CX service principals
|
|
15707
|
+
* @param {*} [options] Override http request option.
|
|
15708
|
+
* @throws {RequiredError}
|
|
15709
|
+
*/
|
|
15710
|
+
getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxServicePrincipalEntity[], any, {}, any>>;
|
|
15662
15711
|
/**
|
|
15663
15712
|
* Get 3CX Credit Status
|
|
15664
15713
|
* @summary Get 3CX Credit Status
|
|
@@ -15687,6 +15736,13 @@ export declare class Class3CXApi extends BaseAPI {
|
|
|
15687
15736
|
* @throws {RequiredError}
|
|
15688
15737
|
*/
|
|
15689
15738
|
getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDTO[], any, {}, any>>;
|
|
15739
|
+
/**
|
|
15740
|
+
* Get 3CX service principals
|
|
15741
|
+
* @param {string} id Instance ID
|
|
15742
|
+
* @param {*} [options] Override http request option.
|
|
15743
|
+
* @throws {RequiredError}
|
|
15744
|
+
*/
|
|
15745
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
15690
15746
|
/**
|
|
15691
15747
|
* Get Bulk 3CX Licence Details
|
|
15692
15748
|
* @summary Get bulk 3CX Licence Details
|
package/dist/api.js
CHANGED
|
@@ -11316,18 +11316,21 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
11316
11316
|
},
|
|
11317
11317
|
/**
|
|
11318
11318
|
* Search for contacts by phone number
|
|
11319
|
+
* @param {string} phone Phone Number
|
|
11319
11320
|
* @param {*} [options] Override http request option.
|
|
11320
11321
|
* @throws {RequiredError}
|
|
11321
11322
|
*/
|
|
11322
|
-
getSearchByPhone: function () {
|
|
11323
|
+
getSearchByPhone: function (phone_1) {
|
|
11323
11324
|
var args_1 = [];
|
|
11324
|
-
for (var _i =
|
|
11325
|
-
args_1[_i] = arguments[_i];
|
|
11325
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
11326
|
+
args_1[_i - 1] = arguments[_i];
|
|
11326
11327
|
}
|
|
11327
|
-
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
11328
|
+
return __awaiter(_this, __spreadArray([phone_1], args_1, true), void 0, function (phone, options) {
|
|
11328
11329
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11329
11330
|
if (options === void 0) { options = {}; }
|
|
11330
11331
|
return __generator(this, function (_a) {
|
|
11332
|
+
// verify required parameter 'phone' is not null or undefined
|
|
11333
|
+
(0, common_1.assertParamExists)('getSearchByPhone', 'phone', phone);
|
|
11331
11334
|
localVarPath = "/crm/contact/search";
|
|
11332
11335
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11333
11336
|
if (configuration) {
|
|
@@ -11336,6 +11339,9 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
11336
11339
|
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
11337
11340
|
localVarHeaderParameter = {};
|
|
11338
11341
|
localVarQueryParameter = {};
|
|
11342
|
+
if (phone !== undefined) {
|
|
11343
|
+
localVarQueryParameter['phone'] = phone;
|
|
11344
|
+
}
|
|
11339
11345
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11340
11346
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11341
11347
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -11462,16 +11468,17 @@ var CRMApiFp = function (configuration) {
|
|
|
11462
11468
|
},
|
|
11463
11469
|
/**
|
|
11464
11470
|
* Search for contacts by phone number
|
|
11471
|
+
* @param {string} phone Phone Number
|
|
11465
11472
|
* @param {*} [options] Override http request option.
|
|
11466
11473
|
* @throws {RequiredError}
|
|
11467
11474
|
*/
|
|
11468
|
-
getSearchByPhone: function (options) {
|
|
11475
|
+
getSearchByPhone: function (phone, options) {
|
|
11469
11476
|
return __awaiter(this, void 0, void 0, function () {
|
|
11470
11477
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11471
11478
|
var _a, _b, _c;
|
|
11472
11479
|
return __generator(this, function (_d) {
|
|
11473
11480
|
switch (_d.label) {
|
|
11474
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(options)];
|
|
11481
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(phone, options)];
|
|
11475
11482
|
case 1:
|
|
11476
11483
|
localVarAxiosArgs = _d.sent();
|
|
11477
11484
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -11549,11 +11556,12 @@ var CRMApiFactory = function (configuration, basePath, axios) {
|
|
|
11549
11556
|
},
|
|
11550
11557
|
/**
|
|
11551
11558
|
* Search for contacts by phone number
|
|
11559
|
+
* @param {string} phone Phone Number
|
|
11552
11560
|
* @param {*} [options] Override http request option.
|
|
11553
11561
|
* @throws {RequiredError}
|
|
11554
11562
|
*/
|
|
11555
|
-
getSearchByPhone: function (options) {
|
|
11556
|
-
return localVarFp.getSearchByPhone(options).then(function (request) { return request(axios, basePath); });
|
|
11563
|
+
getSearchByPhone: function (phone, options) {
|
|
11564
|
+
return localVarFp.getSearchByPhone(phone, options).then(function (request) { return request(axios, basePath); });
|
|
11557
11565
|
},
|
|
11558
11566
|
/**
|
|
11559
11567
|
* Create CRM Note
|
|
@@ -11600,12 +11608,13 @@ var CRMApi = /** @class */ (function (_super) {
|
|
|
11600
11608
|
};
|
|
11601
11609
|
/**
|
|
11602
11610
|
* Search for contacts by phone number
|
|
11611
|
+
* @param {string} phone Phone Number
|
|
11603
11612
|
* @param {*} [options] Override http request option.
|
|
11604
11613
|
* @throws {RequiredError}
|
|
11605
11614
|
*/
|
|
11606
|
-
CRMApi.prototype.getSearchByPhone = function (options) {
|
|
11615
|
+
CRMApi.prototype.getSearchByPhone = function (phone, options) {
|
|
11607
11616
|
var _this = this;
|
|
11608
|
-
return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11617
|
+
return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(phone, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11609
11618
|
};
|
|
11610
11619
|
/**
|
|
11611
11620
|
* Create CRM Note
|
|
@@ -11720,6 +11729,39 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
|
|
|
11720
11729
|
});
|
|
11721
11730
|
});
|
|
11722
11731
|
},
|
|
11732
|
+
/**
|
|
11733
|
+
* Get 3CX service principals
|
|
11734
|
+
* @param {*} [options] Override http request option.
|
|
11735
|
+
* @throws {RequiredError}
|
|
11736
|
+
*/
|
|
11737
|
+
getGetServicePrincipals: function () {
|
|
11738
|
+
var args_1 = [];
|
|
11739
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
11740
|
+
args_1[_i] = arguments[_i];
|
|
11741
|
+
}
|
|
11742
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
11743
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11744
|
+
if (options === void 0) { options = {}; }
|
|
11745
|
+
return __generator(this, function (_a) {
|
|
11746
|
+
localVarPath = "/tcx/cc/services";
|
|
11747
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11748
|
+
if (configuration) {
|
|
11749
|
+
baseOptions = configuration.baseOptions;
|
|
11750
|
+
}
|
|
11751
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
11752
|
+
localVarHeaderParameter = {};
|
|
11753
|
+
localVarQueryParameter = {};
|
|
11754
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11755
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11756
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11757
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11758
|
+
return [2 /*return*/, {
|
|
11759
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11760
|
+
options: localVarRequestOptions,
|
|
11761
|
+
}];
|
|
11762
|
+
});
|
|
11763
|
+
});
|
|
11764
|
+
},
|
|
11723
11765
|
/**
|
|
11724
11766
|
* Get 3CX Credit Status
|
|
11725
11767
|
* @summary Get 3CX Credit Status
|
|
@@ -11856,6 +11898,42 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
|
|
|
11856
11898
|
});
|
|
11857
11899
|
});
|
|
11858
11900
|
},
|
|
11901
|
+
/**
|
|
11902
|
+
* Get 3CX service principals
|
|
11903
|
+
* @param {string} id Instance ID
|
|
11904
|
+
* @param {*} [options] Override http request option.
|
|
11905
|
+
* @throws {RequiredError}
|
|
11906
|
+
*/
|
|
11907
|
+
postAuthenticateInstanceWebsocket: function (id_1) {
|
|
11908
|
+
var args_1 = [];
|
|
11909
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
11910
|
+
args_1[_i - 1] = arguments[_i];
|
|
11911
|
+
}
|
|
11912
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
11913
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11914
|
+
if (options === void 0) { options = {}; }
|
|
11915
|
+
return __generator(this, function (_a) {
|
|
11916
|
+
// verify required parameter 'id' is not null or undefined
|
|
11917
|
+
(0, common_1.assertParamExists)('postAuthenticateInstanceWebsocket', 'id', id);
|
|
11918
|
+
localVarPath = "/tcx/cc/instance/auth/{id}"
|
|
11919
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
11920
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11921
|
+
if (configuration) {
|
|
11922
|
+
baseOptions = configuration.baseOptions;
|
|
11923
|
+
}
|
|
11924
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
11925
|
+
localVarHeaderParameter = {};
|
|
11926
|
+
localVarQueryParameter = {};
|
|
11927
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11928
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11929
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11930
|
+
return [2 /*return*/, {
|
|
11931
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11932
|
+
options: localVarRequestOptions,
|
|
11933
|
+
}];
|
|
11934
|
+
});
|
|
11935
|
+
});
|
|
11936
|
+
},
|
|
11859
11937
|
/**
|
|
11860
11938
|
* Get Bulk 3CX Licence Details
|
|
11861
11939
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -11946,6 +12024,27 @@ var Class3CXApiFp = function (configuration) {
|
|
|
11946
12024
|
});
|
|
11947
12025
|
});
|
|
11948
12026
|
},
|
|
12027
|
+
/**
|
|
12028
|
+
* Get 3CX service principals
|
|
12029
|
+
* @param {*} [options] Override http request option.
|
|
12030
|
+
* @throws {RequiredError}
|
|
12031
|
+
*/
|
|
12032
|
+
getGetServicePrincipals: function (options) {
|
|
12033
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
12034
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
12035
|
+
var _a, _b, _c;
|
|
12036
|
+
return __generator(this, function (_d) {
|
|
12037
|
+
switch (_d.label) {
|
|
12038
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetServicePrincipals(options)];
|
|
12039
|
+
case 1:
|
|
12040
|
+
localVarAxiosArgs = _d.sent();
|
|
12041
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12042
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetServicePrincipals']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12043
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
12044
|
+
}
|
|
12045
|
+
});
|
|
12046
|
+
});
|
|
12047
|
+
},
|
|
11949
12048
|
/**
|
|
11950
12049
|
* Get 3CX Credit Status
|
|
11951
12050
|
* @summary Get 3CX Credit Status
|
|
@@ -12034,6 +12133,28 @@ var Class3CXApiFp = function (configuration) {
|
|
|
12034
12133
|
});
|
|
12035
12134
|
});
|
|
12036
12135
|
},
|
|
12136
|
+
/**
|
|
12137
|
+
* Get 3CX service principals
|
|
12138
|
+
* @param {string} id Instance ID
|
|
12139
|
+
* @param {*} [options] Override http request option.
|
|
12140
|
+
* @throws {RequiredError}
|
|
12141
|
+
*/
|
|
12142
|
+
postAuthenticateInstanceWebsocket: function (id, options) {
|
|
12143
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
12144
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
12145
|
+
var _a, _b, _c;
|
|
12146
|
+
return __generator(this, function (_d) {
|
|
12147
|
+
switch (_d.label) {
|
|
12148
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAuthenticateInstanceWebsocket(id, options)];
|
|
12149
|
+
case 1:
|
|
12150
|
+
localVarAxiosArgs = _d.sent();
|
|
12151
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12152
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.postAuthenticateInstanceWebsocket']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12153
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
12154
|
+
}
|
|
12155
|
+
});
|
|
12156
|
+
});
|
|
12157
|
+
},
|
|
12037
12158
|
/**
|
|
12038
12159
|
* Get Bulk 3CX Licence Details
|
|
12039
12160
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -12084,6 +12205,14 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
|
|
|
12084
12205
|
getGetLicenceDetails: function (key, options) {
|
|
12085
12206
|
return localVarFp.getGetLicenceDetails(key, options).then(function (request) { return request(axios, basePath); });
|
|
12086
12207
|
},
|
|
12208
|
+
/**
|
|
12209
|
+
* Get 3CX service principals
|
|
12210
|
+
* @param {*} [options] Override http request option.
|
|
12211
|
+
* @throws {RequiredError}
|
|
12212
|
+
*/
|
|
12213
|
+
getGetServicePrincipals: function (options) {
|
|
12214
|
+
return localVarFp.getGetServicePrincipals(options).then(function (request) { return request(axios, basePath); });
|
|
12215
|
+
},
|
|
12087
12216
|
/**
|
|
12088
12217
|
* Get 3CX Credit Status
|
|
12089
12218
|
* @summary Get 3CX Credit Status
|
|
@@ -12120,6 +12249,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
|
|
|
12120
12249
|
getGetTcxPartners: function (options) {
|
|
12121
12250
|
return localVarFp.getGetTcxPartners(options).then(function (request) { return request(axios, basePath); });
|
|
12122
12251
|
},
|
|
12252
|
+
/**
|
|
12253
|
+
* Get 3CX service principals
|
|
12254
|
+
* @param {string} id Instance ID
|
|
12255
|
+
* @param {*} [options] Override http request option.
|
|
12256
|
+
* @throws {RequiredError}
|
|
12257
|
+
*/
|
|
12258
|
+
postAuthenticateInstanceWebsocket: function (id, options) {
|
|
12259
|
+
return localVarFp.postAuthenticateInstanceWebsocket(id, options).then(function (request) { return request(axios, basePath); });
|
|
12260
|
+
},
|
|
12123
12261
|
/**
|
|
12124
12262
|
* Get Bulk 3CX Licence Details
|
|
12125
12263
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -12161,6 +12299,15 @@ var Class3CXApi = /** @class */ (function (_super) {
|
|
|
12161
12299
|
var _this = this;
|
|
12162
12300
|
return (0, exports.Class3CXApiFp)(this.configuration).getGetLicenceDetails(key, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12163
12301
|
};
|
|
12302
|
+
/**
|
|
12303
|
+
* Get 3CX service principals
|
|
12304
|
+
* @param {*} [options] Override http request option.
|
|
12305
|
+
* @throws {RequiredError}
|
|
12306
|
+
*/
|
|
12307
|
+
Class3CXApi.prototype.getGetServicePrincipals = function (options) {
|
|
12308
|
+
var _this = this;
|
|
12309
|
+
return (0, exports.Class3CXApiFp)(this.configuration).getGetServicePrincipals(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12310
|
+
};
|
|
12164
12311
|
/**
|
|
12165
12312
|
* Get 3CX Credit Status
|
|
12166
12313
|
* @summary Get 3CX Credit Status
|
|
@@ -12201,6 +12348,16 @@ var Class3CXApi = /** @class */ (function (_super) {
|
|
|
12201
12348
|
var _this = this;
|
|
12202
12349
|
return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12203
12350
|
};
|
|
12351
|
+
/**
|
|
12352
|
+
* Get 3CX service principals
|
|
12353
|
+
* @param {string} id Instance ID
|
|
12354
|
+
* @param {*} [options] Override http request option.
|
|
12355
|
+
* @throws {RequiredError}
|
|
12356
|
+
*/
|
|
12357
|
+
Class3CXApi.prototype.postAuthenticateInstanceWebsocket = function (id, options) {
|
|
12358
|
+
var _this = this;
|
|
12359
|
+
return (0, exports.Class3CXApiFp)(this.configuration).postAuthenticateInstanceWebsocket(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12360
|
+
};
|
|
12204
12361
|
/**
|
|
12205
12362
|
* Get Bulk 3CX Licence Details
|
|
12206
12363
|
* @summary Get bulk 3CX Licence Details
|
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
|
-
|
|
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
|
-
|
|
96
|
+
|
|
97
|
+
|Name | Type | Description | Notes|
|
|
98
|
+
|------------- | ------------- | ------------- | -------------|
|
|
99
|
+
| **phone** | [**string**] | Phone Number | defaults to undefined|
|
|
93
100
|
|
|
94
101
|
|
|
95
102
|
### Return type
|
package/docs/Class3CXApi.md
CHANGED
|
@@ -6,10 +6,12 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetCCDevices**](#getgetccdevices) | **GET** /tcx/cc/devices | |
|
|
8
8
|
|[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
|
|
9
|
+
|[**getGetServicePrincipals**](#getgetserviceprincipals) | **GET** /tcx/cc/services | |
|
|
9
10
|
|[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
|
|
10
11
|
|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
|
|
11
12
|
|[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
|
|
12
13
|
|[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
|
|
14
|
+
|[**postAuthenticateInstanceWebsocket**](#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} | |
|
|
13
15
|
|[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
|
|
14
16
|
|
|
15
17
|
# **getGetCCDevices**
|
|
@@ -113,6 +115,53 @@ No authorization required
|
|
|
113
115
|
|
|
114
116
|
[[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)
|
|
115
117
|
|
|
118
|
+
# **getGetServicePrincipals**
|
|
119
|
+
> Array<TcxServicePrincipalEntity> getGetServicePrincipals()
|
|
120
|
+
|
|
121
|
+
Get 3CX service principals
|
|
122
|
+
|
|
123
|
+
### Example
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import {
|
|
127
|
+
Class3CXApi,
|
|
128
|
+
Configuration
|
|
129
|
+
} from 'yellowgrid-api-ts';
|
|
130
|
+
|
|
131
|
+
const configuration = new Configuration();
|
|
132
|
+
const apiInstance = new Class3CXApi(configuration);
|
|
133
|
+
|
|
134
|
+
const { status, data } = await apiInstance.getGetServicePrincipals();
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
This endpoint does not have any parameters.
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
**Array<TcxServicePrincipalEntity>**
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
No authorization required
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: application/json
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### HTTP response details
|
|
156
|
+
| Status code | Description | Response headers |
|
|
157
|
+
|-------------|-------------|------------------|
|
|
158
|
+
|**200** | Service Principals | - |
|
|
159
|
+
|**400** | Bad Request | - |
|
|
160
|
+
|**401** | Unauthorised | - |
|
|
161
|
+
|**403** | Access Denied | - |
|
|
162
|
+
|
|
163
|
+
[[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)
|
|
164
|
+
|
|
116
165
|
# **getGetTcxCreditStatus**
|
|
117
166
|
> CreditStatusDTO getGetTcxCreditStatus()
|
|
118
167
|
|
|
@@ -301,6 +350,60 @@ No authorization required
|
|
|
301
350
|
|
|
302
351
|
[[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)
|
|
303
352
|
|
|
353
|
+
# **postAuthenticateInstanceWebsocket**
|
|
354
|
+
> postAuthenticateInstanceWebsocket()
|
|
355
|
+
|
|
356
|
+
Get 3CX service principals
|
|
357
|
+
|
|
358
|
+
### Example
|
|
359
|
+
|
|
360
|
+
```typescript
|
|
361
|
+
import {
|
|
362
|
+
Class3CXApi,
|
|
363
|
+
Configuration
|
|
364
|
+
} from 'yellowgrid-api-ts';
|
|
365
|
+
|
|
366
|
+
const configuration = new Configuration();
|
|
367
|
+
const apiInstance = new Class3CXApi(configuration);
|
|
368
|
+
|
|
369
|
+
let id: string; //Instance ID (default to undefined)
|
|
370
|
+
|
|
371
|
+
const { status, data } = await apiInstance.postAuthenticateInstanceWebsocket(
|
|
372
|
+
id
|
|
373
|
+
);
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
|Name | Type | Description | Notes|
|
|
379
|
+
|------------- | ------------- | ------------- | -------------|
|
|
380
|
+
| **id** | [**string**] | Instance ID | defaults to undefined|
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
void (empty response body)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
No authorization required
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: Not defined
|
|
394
|
+
- **Accept**: Not defined
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
### HTTP response details
|
|
398
|
+
| Status code | Description | Response headers |
|
|
399
|
+
|-------------|-------------|------------------|
|
|
400
|
+
|**200** | No Response | - |
|
|
401
|
+
|**400** | Bad Request | - |
|
|
402
|
+
|**401** | Unauthorised | - |
|
|
403
|
+
|**403** | Access Denied | - |
|
|
404
|
+
|
|
405
|
+
[[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)
|
|
406
|
+
|
|
304
407
|
# **postGetBulkLicenceDetails**
|
|
305
408
|
> TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
|
|
306
409
|
|