yellowgrid-api-ts 3.2.343 → 3.2.345
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/.openapi-generator/FILES +4 -0
- package/README.md +5 -0
- package/api.ts +187 -0
- package/dist/api.d.ts +148 -0
- package/dist/api.js +94 -5
- package/docs/AdminUserModel.md +2 -0
- package/docs/Class3CXApi.md +48 -0
- package/docs/DeviceModel.md +25 -0
- package/docs/RequestDTO.md +29 -0
- package/docs/ResponseDTO.md +35 -0
- package/docs/TcxServicePrincipalEntity.md +27 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -101,6 +101,7 @@ docs/DdiRangeRequestModel.md
|
|
|
101
101
|
docs/DdiRangesRequestModel.md
|
|
102
102
|
docs/DetailedItemRequestDTO.md
|
|
103
103
|
docs/DetailedOrderRequestDTO.md
|
|
104
|
+
docs/DeviceModel.md
|
|
104
105
|
docs/DivertRequestModel.md
|
|
105
106
|
docs/DivertResponseModel.md
|
|
106
107
|
docs/EdTechProClientEntity.md
|
|
@@ -260,8 +261,10 @@ docs/RecurringCharge.md
|
|
|
260
261
|
docs/RemoteStorageDTO.md
|
|
261
262
|
docs/ReportRequestDTO.md
|
|
262
263
|
docs/ReportsApi.md
|
|
264
|
+
docs/RequestDTO.md
|
|
263
265
|
docs/ResolutionRequestModel.md
|
|
264
266
|
docs/ResourceNotReadyException.md
|
|
267
|
+
docs/ResponseDTO.md
|
|
265
268
|
docs/RmaCollectionDTO.md
|
|
266
269
|
docs/RmaCreditItemRequestDTO.md
|
|
267
270
|
docs/RmaDTO.md
|
|
@@ -388,6 +391,7 @@ docs/TcxSbcDTO.md
|
|
|
388
391
|
docs/TcxSbcEntity.md
|
|
389
392
|
docs/TcxSbcModel.md
|
|
390
393
|
docs/TcxSbcResponseDTO.md
|
|
394
|
+
docs/TcxServicePrincipalEntity.md
|
|
391
395
|
docs/TcxSetupEntity.md
|
|
392
396
|
docs/TcxSetupsModel.md
|
|
393
397
|
docs/TcxSipTrunksEntity.md
|
package/README.md
CHANGED
|
@@ -181,6 +181,7 @@ Class | Method | HTTP request | Description
|
|
|
181
181
|
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
182
182
|
*CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note |
|
|
183
183
|
*CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal |
|
|
184
|
+
*Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices |
|
|
184
185
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
185
186
|
*Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
|
|
186
187
|
*Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
|
|
@@ -541,6 +542,7 @@ Class | Method | HTTP request | Description
|
|
|
541
542
|
- [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
|
|
542
543
|
- [DetailedItemRequestDTO](docs/DetailedItemRequestDTO.md)
|
|
543
544
|
- [DetailedOrderRequestDTO](docs/DetailedOrderRequestDTO.md)
|
|
545
|
+
- [DeviceModel](docs/DeviceModel.md)
|
|
544
546
|
- [DivertRequestModel](docs/DivertRequestModel.md)
|
|
545
547
|
- [DivertResponseModel](docs/DivertResponseModel.md)
|
|
546
548
|
- [EdTechProClientEntity](docs/EdTechProClientEntity.md)
|
|
@@ -688,8 +690,10 @@ Class | Method | HTTP request | Description
|
|
|
688
690
|
- [RecurringCharge](docs/RecurringCharge.md)
|
|
689
691
|
- [RemoteStorageDTO](docs/RemoteStorageDTO.md)
|
|
690
692
|
- [ReportRequestDTO](docs/ReportRequestDTO.md)
|
|
693
|
+
- [RequestDTO](docs/RequestDTO.md)
|
|
691
694
|
- [ResolutionRequestModel](docs/ResolutionRequestModel.md)
|
|
692
695
|
- [ResourceNotReadyException](docs/ResourceNotReadyException.md)
|
|
696
|
+
- [ResponseDTO](docs/ResponseDTO.md)
|
|
693
697
|
- [RmaCollectionDTO](docs/RmaCollectionDTO.md)
|
|
694
698
|
- [RmaCreditItemRequestDTO](docs/RmaCreditItemRequestDTO.md)
|
|
695
699
|
- [RmaDTO](docs/RmaDTO.md)
|
|
@@ -809,6 +813,7 @@ Class | Method | HTTP request | Description
|
|
|
809
813
|
- [TcxSbcEntity](docs/TcxSbcEntity.md)
|
|
810
814
|
- [TcxSbcModel](docs/TcxSbcModel.md)
|
|
811
815
|
- [TcxSbcResponseDTO](docs/TcxSbcResponseDTO.md)
|
|
816
|
+
- [TcxServicePrincipalEntity](docs/TcxServicePrincipalEntity.md)
|
|
812
817
|
- [TcxSetupEntity](docs/TcxSetupEntity.md)
|
|
813
818
|
- [TcxSetupsModel](docs/TcxSetupsModel.md)
|
|
814
819
|
- [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)
|
package/api.ts
CHANGED
|
@@ -1053,6 +1053,10 @@ export interface AdminUserModel {
|
|
|
1053
1053
|
* Groups
|
|
1054
1054
|
*/
|
|
1055
1055
|
'permissions': Array<AdminUserModelPermissionsEnum>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Extension Number
|
|
1058
|
+
*/
|
|
1059
|
+
'extNo': number;
|
|
1056
1060
|
}
|
|
1057
1061
|
|
|
1058
1062
|
export const AdminUserModelRoleEnum = {
|
|
@@ -1346,6 +1350,7 @@ export const AuditLogEntityTypeEnum = {
|
|
|
1346
1350
|
Pops3cxSetup: 'pops_3cx_setup',
|
|
1347
1351
|
Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
|
|
1348
1352
|
Pops3cxUsers: 'pops_3cx_users',
|
|
1353
|
+
_3cxServicePrincipals: '3cx_service_principals',
|
|
1349
1354
|
PopsUsers: 'pops_users',
|
|
1350
1355
|
PopsVideoRequests: 'pops_video_requests',
|
|
1351
1356
|
Webhook: 'webhook',
|
|
@@ -3014,6 +3019,23 @@ export interface DetailedOrderRequestDTO {
|
|
|
3014
3019
|
*/
|
|
3015
3020
|
'quote': boolean;
|
|
3016
3021
|
}
|
|
3022
|
+
/**
|
|
3023
|
+
* 3CX Call Control Device
|
|
3024
|
+
*/
|
|
3025
|
+
export interface DeviceModel {
|
|
3026
|
+
/**
|
|
3027
|
+
* DN
|
|
3028
|
+
*/
|
|
3029
|
+
'dn'?: string | null;
|
|
3030
|
+
/**
|
|
3031
|
+
* Device ID
|
|
3032
|
+
*/
|
|
3033
|
+
'deviceId'?: string | null;
|
|
3034
|
+
/**
|
|
3035
|
+
* User Agent
|
|
3036
|
+
*/
|
|
3037
|
+
'userAgent'?: string | null;
|
|
3038
|
+
}
|
|
3017
3039
|
/**
|
|
3018
3040
|
* Divert Request
|
|
3019
3041
|
*/
|
|
@@ -6914,6 +6936,45 @@ export const ReportRequestDTOGraphTypeEnum = {
|
|
|
6914
6936
|
|
|
6915
6937
|
export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
|
|
6916
6938
|
|
|
6939
|
+
/**
|
|
6940
|
+
* 3CX Call Control Request
|
|
6941
|
+
*/
|
|
6942
|
+
export interface RequestDTO {
|
|
6943
|
+
/**
|
|
6944
|
+
* ID
|
|
6945
|
+
*/
|
|
6946
|
+
'id'?: number | null;
|
|
6947
|
+
/**
|
|
6948
|
+
* Action
|
|
6949
|
+
*/
|
|
6950
|
+
'action': RequestDTOActionEnum;
|
|
6951
|
+
/**
|
|
6952
|
+
* Number
|
|
6953
|
+
*/
|
|
6954
|
+
'number'?: string | null;
|
|
6955
|
+
/**
|
|
6956
|
+
* From
|
|
6957
|
+
*/
|
|
6958
|
+
'from'?: string | null;
|
|
6959
|
+
/**
|
|
6960
|
+
* Device ID
|
|
6961
|
+
*/
|
|
6962
|
+
'deviceId'?: string | null;
|
|
6963
|
+
}
|
|
6964
|
+
|
|
6965
|
+
export const RequestDTOActionEnum = {
|
|
6966
|
+
Drop: 'drop',
|
|
6967
|
+
Answer: 'answer',
|
|
6968
|
+
Divert: 'divert',
|
|
6969
|
+
Routeto: 'routeto',
|
|
6970
|
+
Transferto: 'transferto',
|
|
6971
|
+
AttachParticipantData: 'attach_participant_data',
|
|
6972
|
+
AttachPartyData: 'attach_party_data',
|
|
6973
|
+
Dial: 'dial',
|
|
6974
|
+
} as const;
|
|
6975
|
+
|
|
6976
|
+
export type RequestDTOActionEnum = typeof RequestDTOActionEnum[keyof typeof RequestDTOActionEnum];
|
|
6977
|
+
|
|
6917
6978
|
/**
|
|
6918
6979
|
* RMA Resolution Request Model
|
|
6919
6980
|
*/
|
|
@@ -6949,6 +7010,54 @@ export interface ResourceNotReadyException {
|
|
|
6949
7010
|
*/
|
|
6950
7011
|
'status': string;
|
|
6951
7012
|
}
|
|
7013
|
+
/**
|
|
7014
|
+
* 3CX Call Control Response
|
|
7015
|
+
*/
|
|
7016
|
+
export interface ResponseDTO {
|
|
7017
|
+
/**
|
|
7018
|
+
* ID
|
|
7019
|
+
*/
|
|
7020
|
+
'id': number;
|
|
7021
|
+
/**
|
|
7022
|
+
* Call ID
|
|
7023
|
+
*/
|
|
7024
|
+
'callId': number;
|
|
7025
|
+
/**
|
|
7026
|
+
* Type
|
|
7027
|
+
*/
|
|
7028
|
+
'type': ResponseDTOTypeEnum;
|
|
7029
|
+
/**
|
|
7030
|
+
* Number
|
|
7031
|
+
*/
|
|
7032
|
+
'number': string;
|
|
7033
|
+
/**
|
|
7034
|
+
* DN
|
|
7035
|
+
*/
|
|
7036
|
+
'dn': string;
|
|
7037
|
+
/**
|
|
7038
|
+
* Date Time
|
|
7039
|
+
*/
|
|
7040
|
+
'startedAt': string;
|
|
7041
|
+
/**
|
|
7042
|
+
* Device ID
|
|
7043
|
+
*/
|
|
7044
|
+
'account'?: AccountSummaryDTO | null;
|
|
7045
|
+
/**
|
|
7046
|
+
* Device
|
|
7047
|
+
*/
|
|
7048
|
+
'device'?: string | null;
|
|
7049
|
+
}
|
|
7050
|
+
|
|
7051
|
+
export const ResponseDTOTypeEnum = {
|
|
7052
|
+
Dialing: 'dialing',
|
|
7053
|
+
Ended: 'ended',
|
|
7054
|
+
Call: 'call',
|
|
7055
|
+
Ringing: 'ringing',
|
|
7056
|
+
Connected: 'connected',
|
|
7057
|
+
} as const;
|
|
7058
|
+
|
|
7059
|
+
export type ResponseDTOTypeEnum = typeof ResponseDTOTypeEnum[keyof typeof ResponseDTOTypeEnum];
|
|
7060
|
+
|
|
6952
7061
|
/**
|
|
6953
7062
|
* RMA Collection Request
|
|
6954
7063
|
*/
|
|
@@ -10733,6 +10842,27 @@ export interface TcxSbcResponseDTO {
|
|
|
10733
10842
|
*/
|
|
10734
10843
|
'message': string;
|
|
10735
10844
|
}
|
|
10845
|
+
/**
|
|
10846
|
+
* TcxServicePrincipalsEntity
|
|
10847
|
+
*/
|
|
10848
|
+
export interface TcxServicePrincipalEntity {
|
|
10849
|
+
/**
|
|
10850
|
+
* id
|
|
10851
|
+
*/
|
|
10852
|
+
'id': string;
|
|
10853
|
+
/**
|
|
10854
|
+
* pbxBase
|
|
10855
|
+
*/
|
|
10856
|
+
'pbxBase': string;
|
|
10857
|
+
/**
|
|
10858
|
+
* appId
|
|
10859
|
+
*/
|
|
10860
|
+
'appId': string;
|
|
10861
|
+
/**
|
|
10862
|
+
* appSecret
|
|
10863
|
+
*/
|
|
10864
|
+
'appSecret': string;
|
|
10865
|
+
}
|
|
10736
10866
|
/**
|
|
10737
10867
|
* 3CX Wizard Setup Config
|
|
10738
10868
|
*/
|
|
@@ -20568,6 +20698,35 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
|
|
|
20568
20698
|
*/
|
|
20569
20699
|
export const Class3CXApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
20570
20700
|
return {
|
|
20701
|
+
/**
|
|
20702
|
+
* Get a list of 3CX call control devices
|
|
20703
|
+
* @param {*} [options] Override http request option.
|
|
20704
|
+
* @throws {RequiredError}
|
|
20705
|
+
*/
|
|
20706
|
+
getGetCCDevices: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20707
|
+
const localVarPath = `/tcx/cc/devices`;
|
|
20708
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20709
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20710
|
+
let baseOptions;
|
|
20711
|
+
if (configuration) {
|
|
20712
|
+
baseOptions = configuration.baseOptions;
|
|
20713
|
+
}
|
|
20714
|
+
|
|
20715
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20716
|
+
const localVarHeaderParameter = {} as any;
|
|
20717
|
+
const localVarQueryParameter = {} as any;
|
|
20718
|
+
|
|
20719
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20720
|
+
|
|
20721
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20722
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20723
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20724
|
+
|
|
20725
|
+
return {
|
|
20726
|
+
url: toPathString(localVarUrlObj),
|
|
20727
|
+
options: localVarRequestOptions,
|
|
20728
|
+
};
|
|
20729
|
+
},
|
|
20571
20730
|
/**
|
|
20572
20731
|
* Get 3CX Licence Details
|
|
20573
20732
|
* @summary Get 3CX Licence Details
|
|
@@ -20767,6 +20926,17 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
20767
20926
|
export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
20768
20927
|
const localVarAxiosParamCreator = Class3CXApiAxiosParamCreator(configuration)
|
|
20769
20928
|
return {
|
|
20929
|
+
/**
|
|
20930
|
+
* Get a list of 3CX call control devices
|
|
20931
|
+
* @param {*} [options] Override http request option.
|
|
20932
|
+
* @throws {RequiredError}
|
|
20933
|
+
*/
|
|
20934
|
+
async getGetCCDevices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DeviceModel>>> {
|
|
20935
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCCDevices(options);
|
|
20936
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20937
|
+
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetCCDevices']?.[localVarOperationServerIndex]?.url;
|
|
20938
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20939
|
+
},
|
|
20770
20940
|
/**
|
|
20771
20941
|
* Get 3CX Licence Details
|
|
20772
20942
|
* @summary Get 3CX Licence Details
|
|
@@ -20850,6 +21020,14 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
|
20850
21020
|
export const Class3CXApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
20851
21021
|
const localVarFp = Class3CXApiFp(configuration)
|
|
20852
21022
|
return {
|
|
21023
|
+
/**
|
|
21024
|
+
* Get a list of 3CX call control devices
|
|
21025
|
+
* @param {*} [options] Override http request option.
|
|
21026
|
+
* @throws {RequiredError}
|
|
21027
|
+
*/
|
|
21028
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): AxiosPromise<Array<DeviceModel>> {
|
|
21029
|
+
return localVarFp.getGetCCDevices(options).then((request) => request(axios, basePath));
|
|
21030
|
+
},
|
|
20853
21031
|
/**
|
|
20854
21032
|
* Get 3CX Licence Details
|
|
20855
21033
|
* @summary Get 3CX Licence Details
|
|
@@ -20913,6 +21091,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
|
|
|
20913
21091
|
* Class3CXApi - object-oriented interface
|
|
20914
21092
|
*/
|
|
20915
21093
|
export class Class3CXApi extends BaseAPI {
|
|
21094
|
+
/**
|
|
21095
|
+
* Get a list of 3CX call control devices
|
|
21096
|
+
* @param {*} [options] Override http request option.
|
|
21097
|
+
* @throws {RequiredError}
|
|
21098
|
+
*/
|
|
21099
|
+
public getGetCCDevices(options?: RawAxiosRequestConfig) {
|
|
21100
|
+
return Class3CXApiFp(this.configuration).getGetCCDevices(options).then((request) => request(this.axios, this.basePath));
|
|
21101
|
+
}
|
|
21102
|
+
|
|
20916
21103
|
/**
|
|
20917
21104
|
* Get 3CX Licence Details
|
|
20918
21105
|
* @summary Get 3CX Licence Details
|
package/dist/api.d.ts
CHANGED
|
@@ -1026,6 +1026,10 @@ export interface AdminUserModel {
|
|
|
1026
1026
|
* Groups
|
|
1027
1027
|
*/
|
|
1028
1028
|
'permissions': Array<AdminUserModelPermissionsEnum>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Extension Number
|
|
1031
|
+
*/
|
|
1032
|
+
'extNo': number;
|
|
1029
1033
|
}
|
|
1030
1034
|
export declare const AdminUserModelRoleEnum: {
|
|
1031
1035
|
readonly NUMBER_0: 0;
|
|
@@ -1313,6 +1317,7 @@ export declare const AuditLogEntityTypeEnum: {
|
|
|
1313
1317
|
readonly Pops3cxSetup: "pops_3cx_setup";
|
|
1314
1318
|
readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
|
|
1315
1319
|
readonly Pops3cxUsers: "pops_3cx_users";
|
|
1320
|
+
readonly _3cxServicePrincipals: "3cx_service_principals";
|
|
1316
1321
|
readonly PopsUsers: "pops_users";
|
|
1317
1322
|
readonly PopsVideoRequests: "pops_video_requests";
|
|
1318
1323
|
readonly Webhook: "webhook";
|
|
@@ -2966,6 +2971,23 @@ export interface DetailedOrderRequestDTO {
|
|
|
2966
2971
|
*/
|
|
2967
2972
|
'quote': boolean;
|
|
2968
2973
|
}
|
|
2974
|
+
/**
|
|
2975
|
+
* 3CX Call Control Device
|
|
2976
|
+
*/
|
|
2977
|
+
export interface DeviceModel {
|
|
2978
|
+
/**
|
|
2979
|
+
* DN
|
|
2980
|
+
*/
|
|
2981
|
+
'dn'?: string | null;
|
|
2982
|
+
/**
|
|
2983
|
+
* Device ID
|
|
2984
|
+
*/
|
|
2985
|
+
'deviceId'?: string | null;
|
|
2986
|
+
/**
|
|
2987
|
+
* User Agent
|
|
2988
|
+
*/
|
|
2989
|
+
'userAgent'?: string | null;
|
|
2990
|
+
}
|
|
2969
2991
|
/**
|
|
2970
2992
|
* Divert Request
|
|
2971
2993
|
*/
|
|
@@ -6805,6 +6827,42 @@ export declare const ReportRequestDTOGraphTypeEnum: {
|
|
|
6805
6827
|
readonly Table: "table";
|
|
6806
6828
|
};
|
|
6807
6829
|
export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
|
|
6830
|
+
/**
|
|
6831
|
+
* 3CX Call Control Request
|
|
6832
|
+
*/
|
|
6833
|
+
export interface RequestDTO {
|
|
6834
|
+
/**
|
|
6835
|
+
* ID
|
|
6836
|
+
*/
|
|
6837
|
+
'id'?: number | null;
|
|
6838
|
+
/**
|
|
6839
|
+
* Action
|
|
6840
|
+
*/
|
|
6841
|
+
'action': RequestDTOActionEnum;
|
|
6842
|
+
/**
|
|
6843
|
+
* Number
|
|
6844
|
+
*/
|
|
6845
|
+
'number'?: string | null;
|
|
6846
|
+
/**
|
|
6847
|
+
* From
|
|
6848
|
+
*/
|
|
6849
|
+
'from'?: string | null;
|
|
6850
|
+
/**
|
|
6851
|
+
* Device ID
|
|
6852
|
+
*/
|
|
6853
|
+
'deviceId'?: string | null;
|
|
6854
|
+
}
|
|
6855
|
+
export declare const RequestDTOActionEnum: {
|
|
6856
|
+
readonly Drop: "drop";
|
|
6857
|
+
readonly Answer: "answer";
|
|
6858
|
+
readonly Divert: "divert";
|
|
6859
|
+
readonly Routeto: "routeto";
|
|
6860
|
+
readonly Transferto: "transferto";
|
|
6861
|
+
readonly AttachParticipantData: "attach_participant_data";
|
|
6862
|
+
readonly AttachPartyData: "attach_party_data";
|
|
6863
|
+
readonly Dial: "dial";
|
|
6864
|
+
};
|
|
6865
|
+
export type RequestDTOActionEnum = typeof RequestDTOActionEnum[keyof typeof RequestDTOActionEnum];
|
|
6808
6866
|
/**
|
|
6809
6867
|
* RMA Resolution Request Model
|
|
6810
6868
|
*/
|
|
@@ -6837,6 +6895,51 @@ export interface ResourceNotReadyException {
|
|
|
6837
6895
|
*/
|
|
6838
6896
|
'status': string;
|
|
6839
6897
|
}
|
|
6898
|
+
/**
|
|
6899
|
+
* 3CX Call Control Response
|
|
6900
|
+
*/
|
|
6901
|
+
export interface ResponseDTO {
|
|
6902
|
+
/**
|
|
6903
|
+
* ID
|
|
6904
|
+
*/
|
|
6905
|
+
'id': number;
|
|
6906
|
+
/**
|
|
6907
|
+
* Call ID
|
|
6908
|
+
*/
|
|
6909
|
+
'callId': number;
|
|
6910
|
+
/**
|
|
6911
|
+
* Type
|
|
6912
|
+
*/
|
|
6913
|
+
'type': ResponseDTOTypeEnum;
|
|
6914
|
+
/**
|
|
6915
|
+
* Number
|
|
6916
|
+
*/
|
|
6917
|
+
'number': string;
|
|
6918
|
+
/**
|
|
6919
|
+
* DN
|
|
6920
|
+
*/
|
|
6921
|
+
'dn': string;
|
|
6922
|
+
/**
|
|
6923
|
+
* Date Time
|
|
6924
|
+
*/
|
|
6925
|
+
'startedAt': string;
|
|
6926
|
+
/**
|
|
6927
|
+
* Device ID
|
|
6928
|
+
*/
|
|
6929
|
+
'account'?: AccountSummaryDTO | null;
|
|
6930
|
+
/**
|
|
6931
|
+
* Device
|
|
6932
|
+
*/
|
|
6933
|
+
'device'?: string | null;
|
|
6934
|
+
}
|
|
6935
|
+
export declare const ResponseDTOTypeEnum: {
|
|
6936
|
+
readonly Dialing: "dialing";
|
|
6937
|
+
readonly Ended: "ended";
|
|
6938
|
+
readonly Call: "call";
|
|
6939
|
+
readonly Ringing: "ringing";
|
|
6940
|
+
readonly Connected: "connected";
|
|
6941
|
+
};
|
|
6942
|
+
export type ResponseDTOTypeEnum = typeof ResponseDTOTypeEnum[keyof typeof ResponseDTOTypeEnum];
|
|
6840
6943
|
/**
|
|
6841
6944
|
* RMA Collection Request
|
|
6842
6945
|
*/
|
|
@@ -10543,6 +10646,27 @@ export interface TcxSbcResponseDTO {
|
|
|
10543
10646
|
*/
|
|
10544
10647
|
'message': string;
|
|
10545
10648
|
}
|
|
10649
|
+
/**
|
|
10650
|
+
* TcxServicePrincipalsEntity
|
|
10651
|
+
*/
|
|
10652
|
+
export interface TcxServicePrincipalEntity {
|
|
10653
|
+
/**
|
|
10654
|
+
* id
|
|
10655
|
+
*/
|
|
10656
|
+
'id': string;
|
|
10657
|
+
/**
|
|
10658
|
+
* pbxBase
|
|
10659
|
+
*/
|
|
10660
|
+
'pbxBase': string;
|
|
10661
|
+
/**
|
|
10662
|
+
* appId
|
|
10663
|
+
*/
|
|
10664
|
+
'appId': string;
|
|
10665
|
+
/**
|
|
10666
|
+
* appSecret
|
|
10667
|
+
*/
|
|
10668
|
+
'appSecret': string;
|
|
10669
|
+
}
|
|
10546
10670
|
/**
|
|
10547
10671
|
* 3CX Wizard Setup Config
|
|
10548
10672
|
*/
|
|
@@ -15356,6 +15480,12 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
|
|
|
15356
15480
|
* Class3CXApi - axios parameter creator
|
|
15357
15481
|
*/
|
|
15358
15482
|
export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15483
|
+
/**
|
|
15484
|
+
* Get a list of 3CX call control devices
|
|
15485
|
+
* @param {*} [options] Override http request option.
|
|
15486
|
+
* @throws {RequiredError}
|
|
15487
|
+
*/
|
|
15488
|
+
getGetCCDevices: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15359
15489
|
/**
|
|
15360
15490
|
* Get 3CX Licence Details
|
|
15361
15491
|
* @summary Get 3CX Licence Details
|
|
@@ -15405,6 +15535,12 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
15405
15535
|
* Class3CXApi - functional programming interface
|
|
15406
15536
|
*/
|
|
15407
15537
|
export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
15538
|
+
/**
|
|
15539
|
+
* Get a list of 3CX call control devices
|
|
15540
|
+
* @param {*} [options] Override http request option.
|
|
15541
|
+
* @throws {RequiredError}
|
|
15542
|
+
*/
|
|
15543
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DeviceModel>>>;
|
|
15408
15544
|
/**
|
|
15409
15545
|
* Get 3CX Licence Details
|
|
15410
15546
|
* @summary Get 3CX Licence Details
|
|
@@ -15454,6 +15590,12 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
|
15454
15590
|
* Class3CXApi - factory interface
|
|
15455
15591
|
*/
|
|
15456
15592
|
export declare const Class3CXApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15593
|
+
/**
|
|
15594
|
+
* Get a list of 3CX call control devices
|
|
15595
|
+
* @param {*} [options] Override http request option.
|
|
15596
|
+
* @throws {RequiredError}
|
|
15597
|
+
*/
|
|
15598
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): AxiosPromise<Array<DeviceModel>>;
|
|
15457
15599
|
/**
|
|
15458
15600
|
* Get 3CX Licence Details
|
|
15459
15601
|
* @summary Get 3CX Licence Details
|
|
@@ -15503,6 +15645,12 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
|
|
|
15503
15645
|
* Class3CXApi - object-oriented interface
|
|
15504
15646
|
*/
|
|
15505
15647
|
export declare class Class3CXApi extends BaseAPI {
|
|
15648
|
+
/**
|
|
15649
|
+
* Get a list of 3CX call control devices
|
|
15650
|
+
* @param {*} [options] Override http request option.
|
|
15651
|
+
* @throws {RequiredError}
|
|
15652
|
+
*/
|
|
15653
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceModel[], any, {}, any>>;
|
|
15506
15654
|
/**
|
|
15507
15655
|
* Get 3CX Licence Details
|
|
15508
15656
|
* @summary Get 3CX Licence Details
|
package/dist/api.js
CHANGED
|
@@ -84,11 +84,11 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
84
84
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
85
|
};
|
|
86
86
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.
|
|
88
|
-
exports.
|
|
89
|
-
exports.
|
|
90
|
-
exports.
|
|
91
|
-
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = void 0;
|
|
87
|
+
exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.SeriesDTOTypeEnum = exports.SdrReferenceType = exports.RmaSummaryDTOStatusEnum = exports.RmaRequestDTORequestedResolutionEnum = exports.RmaRequestDTOReasonEnum = exports.RmaItemDTOStatusEnum = exports.RmaDTOStatusEnum = exports.RmaDTOResolutionEnum = exports.RmaDTOReasonEnum = exports.RmaCreditItemRequestDTORefundPercentageEnum = exports.ResponseDTOTypeEnum = exports.ResolutionRequestModelResolutionEnum = exports.RequestDTOActionEnum = exports.ReportRequestDTOGraphTypeEnum = exports.ReportRequestDTOReportEnum = exports.ReasonRequestModelReasonEnum = exports.ProspectDTOStatusEnum = exports.PostGetServicePlansRequestPlanGroupEnum = exports.PatchUpdateTcxHostingPriceListRequestPriceListEnum = exports.PatchUpdatePriceListRequestPriceListEnum = exports.PasswordSenderDTOIntervalTypeEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.OrderDetailsDTOPaymentMethodEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemResolutionRequestModelResolutionEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.GraphDTOCurrencyEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.CustomerRateType = exports.BrandedVideoSummaryDTOStatusEnum = exports.BrandedVideoSummaryDTOTypeEnum = exports.AxisDataDTOTypeEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelPermissionsEnum = exports.AdminUserModelRoleEnum = exports.AdminRmaSummaryDTOStatusEnum = exports.AdminRmaItemDTOResolutionEnum = exports.AdminRmaItemDTOStatusEnum = exports.AdminRmaDTOStatusEnum = exports.AdminRmaDTOResolutionEnum = exports.AdminRmaDTOReasonEnum = exports.AdminOrderRequestDTOPaymentMethodEnum = void 0;
|
|
88
|
+
exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.GetGetBrandedVideosTypeEnum = exports.BrandedVideosApi = exports.BrandedVideosApiFactory = exports.BrandedVideosApiFp = exports.BrandedVideosApiAxiosParamCreator = exports.GetGetServicesPlanDetailsTypeEnum = exports.GetGetConnectionsTypeEnum = exports.BillingApi = exports.BillingApiFactory = exports.BillingApiFp = exports.BillingApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = exports.PatchSetOnHoldStateEnum = exports.PatchSetAccountStatusStateEnum = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.SupplierProductDTOCategoryEnum = exports.StockReportItemModelCurrencyEnum = exports.StockProductModelCategoryEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = void 0;
|
|
89
|
+
exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.MiscApi = exports.MiscApiFactory = exports.MiscApiFp = exports.MiscApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.PatchMarkEngineerTaskAsCompleteCompleteEnum = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = void 0;
|
|
90
|
+
exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.RMAApi = exports.RMAApiFactory = exports.RMAApiFp = exports.RMAApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.ProspectsApi = exports.ProspectsApiFactory = exports.ProspectsApiFp = exports.ProspectsApiAxiosParamCreator = exports.PromotionsApi = exports.PromotionsApiFactory = exports.PromotionsApiFp = exports.PromotionsApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = void 0;
|
|
91
|
+
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = void 0;
|
|
92
92
|
var axios_1 = require("axios");
|
|
93
93
|
// Some imports not used depending on template conditions
|
|
94
94
|
// @ts-ignore
|
|
@@ -241,6 +241,7 @@ exports.AuditLogEntityTypeEnum = {
|
|
|
241
241
|
Pops3cxSetup: 'pops_3cx_setup',
|
|
242
242
|
Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
|
|
243
243
|
Pops3cxUsers: 'pops_3cx_users',
|
|
244
|
+
_3cxServicePrincipals: '3cx_service_principals',
|
|
244
245
|
PopsUsers: 'pops_users',
|
|
245
246
|
PopsVideoRequests: 'pops_video_requests',
|
|
246
247
|
Webhook: 'webhook',
|
|
@@ -473,11 +474,28 @@ exports.ReportRequestDTOGraphTypeEnum = {
|
|
|
473
474
|
StackedArea: 'stacked-area',
|
|
474
475
|
Table: 'table',
|
|
475
476
|
};
|
|
477
|
+
exports.RequestDTOActionEnum = {
|
|
478
|
+
Drop: 'drop',
|
|
479
|
+
Answer: 'answer',
|
|
480
|
+
Divert: 'divert',
|
|
481
|
+
Routeto: 'routeto',
|
|
482
|
+
Transferto: 'transferto',
|
|
483
|
+
AttachParticipantData: 'attach_participant_data',
|
|
484
|
+
AttachPartyData: 'attach_party_data',
|
|
485
|
+
Dial: 'dial',
|
|
486
|
+
};
|
|
476
487
|
exports.ResolutionRequestModelResolutionEnum = {
|
|
477
488
|
NUMBER_1: 1,
|
|
478
489
|
NUMBER_2: 2,
|
|
479
490
|
NUMBER_3: 3,
|
|
480
491
|
};
|
|
492
|
+
exports.ResponseDTOTypeEnum = {
|
|
493
|
+
Dialing: 'dialing',
|
|
494
|
+
Ended: 'ended',
|
|
495
|
+
Call: 'call',
|
|
496
|
+
Ringing: 'ringing',
|
|
497
|
+
Connected: 'connected',
|
|
498
|
+
};
|
|
481
499
|
exports.RmaCreditItemRequestDTORefundPercentageEnum = {
|
|
482
500
|
NUMBER_100: 100,
|
|
483
501
|
NUMBER_85: 85,
|
|
@@ -11629,6 +11647,39 @@ exports.GetGetCrmActivitiesTypeEnum = {
|
|
|
11629
11647
|
var Class3CXApiAxiosParamCreator = function (configuration) {
|
|
11630
11648
|
var _this = this;
|
|
11631
11649
|
return {
|
|
11650
|
+
/**
|
|
11651
|
+
* Get a list of 3CX call control devices
|
|
11652
|
+
* @param {*} [options] Override http request option.
|
|
11653
|
+
* @throws {RequiredError}
|
|
11654
|
+
*/
|
|
11655
|
+
getGetCCDevices: function () {
|
|
11656
|
+
var args_1 = [];
|
|
11657
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
11658
|
+
args_1[_i] = arguments[_i];
|
|
11659
|
+
}
|
|
11660
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
11661
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11662
|
+
if (options === void 0) { options = {}; }
|
|
11663
|
+
return __generator(this, function (_a) {
|
|
11664
|
+
localVarPath = "/tcx/cc/devices";
|
|
11665
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11666
|
+
if (configuration) {
|
|
11667
|
+
baseOptions = configuration.baseOptions;
|
|
11668
|
+
}
|
|
11669
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
11670
|
+
localVarHeaderParameter = {};
|
|
11671
|
+
localVarQueryParameter = {};
|
|
11672
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11673
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11674
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11675
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11676
|
+
return [2 /*return*/, {
|
|
11677
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11678
|
+
options: localVarRequestOptions,
|
|
11679
|
+
}];
|
|
11680
|
+
});
|
|
11681
|
+
});
|
|
11682
|
+
},
|
|
11632
11683
|
/**
|
|
11633
11684
|
* Get 3CX Licence Details
|
|
11634
11685
|
* @summary Get 3CX Licence Details
|
|
@@ -11851,6 +11902,27 @@ exports.Class3CXApiAxiosParamCreator = Class3CXApiAxiosParamCreator;
|
|
|
11851
11902
|
var Class3CXApiFp = function (configuration) {
|
|
11852
11903
|
var localVarAxiosParamCreator = (0, exports.Class3CXApiAxiosParamCreator)(configuration);
|
|
11853
11904
|
return {
|
|
11905
|
+
/**
|
|
11906
|
+
* Get a list of 3CX call control devices
|
|
11907
|
+
* @param {*} [options] Override http request option.
|
|
11908
|
+
* @throws {RequiredError}
|
|
11909
|
+
*/
|
|
11910
|
+
getGetCCDevices: function (options) {
|
|
11911
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11912
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11913
|
+
var _a, _b, _c;
|
|
11914
|
+
return __generator(this, function (_d) {
|
|
11915
|
+
switch (_d.label) {
|
|
11916
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCCDevices(options)];
|
|
11917
|
+
case 1:
|
|
11918
|
+
localVarAxiosArgs = _d.sent();
|
|
11919
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11920
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetCCDevices']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11921
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11922
|
+
}
|
|
11923
|
+
});
|
|
11924
|
+
});
|
|
11925
|
+
},
|
|
11854
11926
|
/**
|
|
11855
11927
|
* Get 3CX Licence Details
|
|
11856
11928
|
* @summary Get 3CX Licence Details
|
|
@@ -11994,6 +12066,14 @@ exports.Class3CXApiFp = Class3CXApiFp;
|
|
|
11994
12066
|
var Class3CXApiFactory = function (configuration, basePath, axios) {
|
|
11995
12067
|
var localVarFp = (0, exports.Class3CXApiFp)(configuration);
|
|
11996
12068
|
return {
|
|
12069
|
+
/**
|
|
12070
|
+
* Get a list of 3CX call control devices
|
|
12071
|
+
* @param {*} [options] Override http request option.
|
|
12072
|
+
* @throws {RequiredError}
|
|
12073
|
+
*/
|
|
12074
|
+
getGetCCDevices: function (options) {
|
|
12075
|
+
return localVarFp.getGetCCDevices(options).then(function (request) { return request(axios, basePath); });
|
|
12076
|
+
},
|
|
11997
12077
|
/**
|
|
11998
12078
|
* Get 3CX Licence Details
|
|
11999
12079
|
* @summary Get 3CX Licence Details
|
|
@@ -12061,6 +12141,15 @@ var Class3CXApi = /** @class */ (function (_super) {
|
|
|
12061
12141
|
function Class3CXApi() {
|
|
12062
12142
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
12063
12143
|
}
|
|
12144
|
+
/**
|
|
12145
|
+
* Get a list of 3CX call control devices
|
|
12146
|
+
* @param {*} [options] Override http request option.
|
|
12147
|
+
* @throws {RequiredError}
|
|
12148
|
+
*/
|
|
12149
|
+
Class3CXApi.prototype.getGetCCDevices = function (options) {
|
|
12150
|
+
var _this = this;
|
|
12151
|
+
return (0, exports.Class3CXApiFp)(this.configuration).getGetCCDevices(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12152
|
+
};
|
|
12064
12153
|
/**
|
|
12065
12154
|
* Get 3CX Licence Details
|
|
12066
12155
|
* @summary Get 3CX Licence Details
|
package/docs/AdminUserModel.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
|
|
17
17
|
**scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
|
|
18
18
|
**permissions** | **Array<string>** | Groups | [default to undefined]
|
|
19
|
+
**extNo** | **number** | Extension Number | [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -33,6 +34,7 @@ const instance: AdminUserModel = {
|
|
|
33
34
|
secondaryHex,
|
|
34
35
|
scopes,
|
|
35
36
|
permissions,
|
|
37
|
+
extNo,
|
|
36
38
|
};
|
|
37
39
|
```
|
|
38
40
|
|
package/docs/Class3CXApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getGetCCDevices**](#getgetccdevices) | **GET** /tcx/cc/devices | |
|
|
7
8
|
|[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
|
|
8
9
|
|[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
|
|
9
10
|
|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
|
|
@@ -11,6 +12,53 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
11
12
|
|[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
|
|
12
13
|
|[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
|
|
13
14
|
|
|
15
|
+
# **getGetCCDevices**
|
|
16
|
+
> Array<DeviceModel> getGetCCDevices()
|
|
17
|
+
|
|
18
|
+
Get a list of 3CX call control devices
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import {
|
|
24
|
+
Class3CXApi,
|
|
25
|
+
Configuration
|
|
26
|
+
} from 'yellowgrid-api-ts';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new Class3CXApi(configuration);
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.getGetCCDevices();
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
This endpoint does not have any parameters.
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### Return type
|
|
39
|
+
|
|
40
|
+
**Array<DeviceModel>**
|
|
41
|
+
|
|
42
|
+
### Authorization
|
|
43
|
+
|
|
44
|
+
No authorization required
|
|
45
|
+
|
|
46
|
+
### HTTP request headers
|
|
47
|
+
|
|
48
|
+
- **Content-Type**: Not defined
|
|
49
|
+
- **Accept**: application/json
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
### HTTP response details
|
|
53
|
+
| Status code | Description | Response headers |
|
|
54
|
+
|-------------|-------------|------------------|
|
|
55
|
+
|**200** | Devices | - |
|
|
56
|
+
|**400** | Bad Request | - |
|
|
57
|
+
|**401** | Unauthorised | - |
|
|
58
|
+
|**403** | Access Denied | - |
|
|
59
|
+
|
|
60
|
+
[[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)
|
|
61
|
+
|
|
14
62
|
# **getGetLicenceDetails**
|
|
15
63
|
> TcxLicenceDetailsModel getGetLicenceDetails()
|
|
16
64
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# DeviceModel
|
|
2
|
+
|
|
3
|
+
3CX Call Control Device
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**dn** | **string** | DN | [optional] [default to undefined]
|
|
10
|
+
**deviceId** | **string** | Device ID | [optional] [default to undefined]
|
|
11
|
+
**userAgent** | **string** | User Agent | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { DeviceModel } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: DeviceModel = {
|
|
19
|
+
dn,
|
|
20
|
+
deviceId,
|
|
21
|
+
userAgent,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# RequestDTO
|
|
2
|
+
|
|
3
|
+
3CX Call Control Request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
+
**action** | **string** | Action | [default to undefined]
|
|
11
|
+
**number** | **string** | Number | [optional] [default to undefined]
|
|
12
|
+
**from** | **string** | From | [optional] [default to undefined]
|
|
13
|
+
**deviceId** | **string** | Device ID | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { RequestDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: RequestDTO = {
|
|
21
|
+
id,
|
|
22
|
+
action,
|
|
23
|
+
number,
|
|
24
|
+
from,
|
|
25
|
+
deviceId,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ResponseDTO
|
|
2
|
+
|
|
3
|
+
3CX Call Control Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**callId** | **number** | Call ID | [default to undefined]
|
|
11
|
+
**type** | **string** | Type | [default to undefined]
|
|
12
|
+
**number** | **string** | Number | [default to undefined]
|
|
13
|
+
**dn** | **string** | DN | [default to undefined]
|
|
14
|
+
**startedAt** | **string** | Date Time | [default to undefined]
|
|
15
|
+
**account** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Device ID | [optional] [default to undefined]
|
|
16
|
+
**device** | **string** | Device | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { ResponseDTO } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: ResponseDTO = {
|
|
24
|
+
id,
|
|
25
|
+
callId,
|
|
26
|
+
type,
|
|
27
|
+
number,
|
|
28
|
+
dn,
|
|
29
|
+
startedAt,
|
|
30
|
+
account,
|
|
31
|
+
device,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TcxServicePrincipalEntity
|
|
2
|
+
|
|
3
|
+
TcxServicePrincipalsEntity
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | id | [default to undefined]
|
|
10
|
+
**pbxBase** | **string** | pbxBase | [default to undefined]
|
|
11
|
+
**appId** | **string** | appId | [default to undefined]
|
|
12
|
+
**appSecret** | **string** | appSecret | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { TcxServicePrincipalEntity } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: TcxServicePrincipalEntity = {
|
|
20
|
+
id,
|
|
21
|
+
pbxBase,
|
|
22
|
+
appId,
|
|
23
|
+
appSecret,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|