yellowgrid-api-ts 3.2.343 → 3.2.344
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 +3 -0
- package/README.md +4 -0
- package/api.ts +165 -0
- package/dist/api.d.ts +126 -0
- package/dist/api.js +93 -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/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
|
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)
|
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 = {
|
|
@@ -3014,6 +3018,23 @@ export interface DetailedOrderRequestDTO {
|
|
|
3014
3018
|
*/
|
|
3015
3019
|
'quote': boolean;
|
|
3016
3020
|
}
|
|
3021
|
+
/**
|
|
3022
|
+
* 3CX Call Control Device
|
|
3023
|
+
*/
|
|
3024
|
+
export interface DeviceModel {
|
|
3025
|
+
/**
|
|
3026
|
+
* DN
|
|
3027
|
+
*/
|
|
3028
|
+
'dn'?: string | null;
|
|
3029
|
+
/**
|
|
3030
|
+
* Device ID
|
|
3031
|
+
*/
|
|
3032
|
+
'deviceId'?: string | null;
|
|
3033
|
+
/**
|
|
3034
|
+
* User Agent
|
|
3035
|
+
*/
|
|
3036
|
+
'userAgent'?: string | null;
|
|
3037
|
+
}
|
|
3017
3038
|
/**
|
|
3018
3039
|
* Divert Request
|
|
3019
3040
|
*/
|
|
@@ -6914,6 +6935,45 @@ export const ReportRequestDTOGraphTypeEnum = {
|
|
|
6914
6935
|
|
|
6915
6936
|
export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
|
|
6916
6937
|
|
|
6938
|
+
/**
|
|
6939
|
+
* 3CX Call Control Request
|
|
6940
|
+
*/
|
|
6941
|
+
export interface RequestDTO {
|
|
6942
|
+
/**
|
|
6943
|
+
* ID
|
|
6944
|
+
*/
|
|
6945
|
+
'id'?: number | null;
|
|
6946
|
+
/**
|
|
6947
|
+
* Action
|
|
6948
|
+
*/
|
|
6949
|
+
'action': RequestDTOActionEnum;
|
|
6950
|
+
/**
|
|
6951
|
+
* Number
|
|
6952
|
+
*/
|
|
6953
|
+
'number'?: string | null;
|
|
6954
|
+
/**
|
|
6955
|
+
* From
|
|
6956
|
+
*/
|
|
6957
|
+
'from'?: string | null;
|
|
6958
|
+
/**
|
|
6959
|
+
* Device ID
|
|
6960
|
+
*/
|
|
6961
|
+
'deviceId'?: string | null;
|
|
6962
|
+
}
|
|
6963
|
+
|
|
6964
|
+
export const RequestDTOActionEnum = {
|
|
6965
|
+
Drop: 'drop',
|
|
6966
|
+
Answer: 'answer',
|
|
6967
|
+
Divert: 'divert',
|
|
6968
|
+
Routeto: 'routeto',
|
|
6969
|
+
Transferto: 'transferto',
|
|
6970
|
+
AttachParticipantData: 'attach_participant_data',
|
|
6971
|
+
AttachPartyData: 'attach_party_data',
|
|
6972
|
+
Dial: 'dial',
|
|
6973
|
+
} as const;
|
|
6974
|
+
|
|
6975
|
+
export type RequestDTOActionEnum = typeof RequestDTOActionEnum[keyof typeof RequestDTOActionEnum];
|
|
6976
|
+
|
|
6917
6977
|
/**
|
|
6918
6978
|
* RMA Resolution Request Model
|
|
6919
6979
|
*/
|
|
@@ -6949,6 +7009,54 @@ export interface ResourceNotReadyException {
|
|
|
6949
7009
|
*/
|
|
6950
7010
|
'status': string;
|
|
6951
7011
|
}
|
|
7012
|
+
/**
|
|
7013
|
+
* 3CX Call Control Response
|
|
7014
|
+
*/
|
|
7015
|
+
export interface ResponseDTO {
|
|
7016
|
+
/**
|
|
7017
|
+
* ID
|
|
7018
|
+
*/
|
|
7019
|
+
'id': number;
|
|
7020
|
+
/**
|
|
7021
|
+
* Call ID
|
|
7022
|
+
*/
|
|
7023
|
+
'callId': number;
|
|
7024
|
+
/**
|
|
7025
|
+
* Type
|
|
7026
|
+
*/
|
|
7027
|
+
'type': ResponseDTOTypeEnum;
|
|
7028
|
+
/**
|
|
7029
|
+
* Number
|
|
7030
|
+
*/
|
|
7031
|
+
'number': string;
|
|
7032
|
+
/**
|
|
7033
|
+
* DN
|
|
7034
|
+
*/
|
|
7035
|
+
'dn': string;
|
|
7036
|
+
/**
|
|
7037
|
+
* Date Time
|
|
7038
|
+
*/
|
|
7039
|
+
'startedAt': string;
|
|
7040
|
+
/**
|
|
7041
|
+
* Device ID
|
|
7042
|
+
*/
|
|
7043
|
+
'account'?: AccountSummaryDTO | null;
|
|
7044
|
+
/**
|
|
7045
|
+
* Device
|
|
7046
|
+
*/
|
|
7047
|
+
'device'?: string | null;
|
|
7048
|
+
}
|
|
7049
|
+
|
|
7050
|
+
export const ResponseDTOTypeEnum = {
|
|
7051
|
+
Dialing: 'dialing',
|
|
7052
|
+
Ended: 'ended',
|
|
7053
|
+
Call: 'call',
|
|
7054
|
+
Ringing: 'ringing',
|
|
7055
|
+
Connected: 'connected',
|
|
7056
|
+
} as const;
|
|
7057
|
+
|
|
7058
|
+
export type ResponseDTOTypeEnum = typeof ResponseDTOTypeEnum[keyof typeof ResponseDTOTypeEnum];
|
|
7059
|
+
|
|
6952
7060
|
/**
|
|
6953
7061
|
* RMA Collection Request
|
|
6954
7062
|
*/
|
|
@@ -20568,6 +20676,35 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
|
|
|
20568
20676
|
*/
|
|
20569
20677
|
export const Class3CXApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
20570
20678
|
return {
|
|
20679
|
+
/**
|
|
20680
|
+
* Get a list of 3CX call control devices
|
|
20681
|
+
* @param {*} [options] Override http request option.
|
|
20682
|
+
* @throws {RequiredError}
|
|
20683
|
+
*/
|
|
20684
|
+
getGetCCDevices: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20685
|
+
const localVarPath = `/tcx/cc/devices`;
|
|
20686
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20687
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20688
|
+
let baseOptions;
|
|
20689
|
+
if (configuration) {
|
|
20690
|
+
baseOptions = configuration.baseOptions;
|
|
20691
|
+
}
|
|
20692
|
+
|
|
20693
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20694
|
+
const localVarHeaderParameter = {} as any;
|
|
20695
|
+
const localVarQueryParameter = {} as any;
|
|
20696
|
+
|
|
20697
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20698
|
+
|
|
20699
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20700
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20701
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20702
|
+
|
|
20703
|
+
return {
|
|
20704
|
+
url: toPathString(localVarUrlObj),
|
|
20705
|
+
options: localVarRequestOptions,
|
|
20706
|
+
};
|
|
20707
|
+
},
|
|
20571
20708
|
/**
|
|
20572
20709
|
* Get 3CX Licence Details
|
|
20573
20710
|
* @summary Get 3CX Licence Details
|
|
@@ -20767,6 +20904,17 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
20767
20904
|
export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
20768
20905
|
const localVarAxiosParamCreator = Class3CXApiAxiosParamCreator(configuration)
|
|
20769
20906
|
return {
|
|
20907
|
+
/**
|
|
20908
|
+
* Get a list of 3CX call control devices
|
|
20909
|
+
* @param {*} [options] Override http request option.
|
|
20910
|
+
* @throws {RequiredError}
|
|
20911
|
+
*/
|
|
20912
|
+
async getGetCCDevices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DeviceModel>>> {
|
|
20913
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCCDevices(options);
|
|
20914
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20915
|
+
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetCCDevices']?.[localVarOperationServerIndex]?.url;
|
|
20916
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20917
|
+
},
|
|
20770
20918
|
/**
|
|
20771
20919
|
* Get 3CX Licence Details
|
|
20772
20920
|
* @summary Get 3CX Licence Details
|
|
@@ -20850,6 +20998,14 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
|
20850
20998
|
export const Class3CXApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
20851
20999
|
const localVarFp = Class3CXApiFp(configuration)
|
|
20852
21000
|
return {
|
|
21001
|
+
/**
|
|
21002
|
+
* Get a list of 3CX call control devices
|
|
21003
|
+
* @param {*} [options] Override http request option.
|
|
21004
|
+
* @throws {RequiredError}
|
|
21005
|
+
*/
|
|
21006
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): AxiosPromise<Array<DeviceModel>> {
|
|
21007
|
+
return localVarFp.getGetCCDevices(options).then((request) => request(axios, basePath));
|
|
21008
|
+
},
|
|
20853
21009
|
/**
|
|
20854
21010
|
* Get 3CX Licence Details
|
|
20855
21011
|
* @summary Get 3CX Licence Details
|
|
@@ -20913,6 +21069,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
|
|
|
20913
21069
|
* Class3CXApi - object-oriented interface
|
|
20914
21070
|
*/
|
|
20915
21071
|
export class Class3CXApi extends BaseAPI {
|
|
21072
|
+
/**
|
|
21073
|
+
* Get a list of 3CX call control devices
|
|
21074
|
+
* @param {*} [options] Override http request option.
|
|
21075
|
+
* @throws {RequiredError}
|
|
21076
|
+
*/
|
|
21077
|
+
public getGetCCDevices(options?: RawAxiosRequestConfig) {
|
|
21078
|
+
return Class3CXApiFp(this.configuration).getGetCCDevices(options).then((request) => request(this.axios, this.basePath));
|
|
21079
|
+
}
|
|
21080
|
+
|
|
20916
21081
|
/**
|
|
20917
21082
|
* Get 3CX Licence Details
|
|
20918
21083
|
* @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;
|
|
@@ -2966,6 +2970,23 @@ export interface DetailedOrderRequestDTO {
|
|
|
2966
2970
|
*/
|
|
2967
2971
|
'quote': boolean;
|
|
2968
2972
|
}
|
|
2973
|
+
/**
|
|
2974
|
+
* 3CX Call Control Device
|
|
2975
|
+
*/
|
|
2976
|
+
export interface DeviceModel {
|
|
2977
|
+
/**
|
|
2978
|
+
* DN
|
|
2979
|
+
*/
|
|
2980
|
+
'dn'?: string | null;
|
|
2981
|
+
/**
|
|
2982
|
+
* Device ID
|
|
2983
|
+
*/
|
|
2984
|
+
'deviceId'?: string | null;
|
|
2985
|
+
/**
|
|
2986
|
+
* User Agent
|
|
2987
|
+
*/
|
|
2988
|
+
'userAgent'?: string | null;
|
|
2989
|
+
}
|
|
2969
2990
|
/**
|
|
2970
2991
|
* Divert Request
|
|
2971
2992
|
*/
|
|
@@ -6805,6 +6826,42 @@ export declare const ReportRequestDTOGraphTypeEnum: {
|
|
|
6805
6826
|
readonly Table: "table";
|
|
6806
6827
|
};
|
|
6807
6828
|
export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
|
|
6829
|
+
/**
|
|
6830
|
+
* 3CX Call Control Request
|
|
6831
|
+
*/
|
|
6832
|
+
export interface RequestDTO {
|
|
6833
|
+
/**
|
|
6834
|
+
* ID
|
|
6835
|
+
*/
|
|
6836
|
+
'id'?: number | null;
|
|
6837
|
+
/**
|
|
6838
|
+
* Action
|
|
6839
|
+
*/
|
|
6840
|
+
'action': RequestDTOActionEnum;
|
|
6841
|
+
/**
|
|
6842
|
+
* Number
|
|
6843
|
+
*/
|
|
6844
|
+
'number'?: string | null;
|
|
6845
|
+
/**
|
|
6846
|
+
* From
|
|
6847
|
+
*/
|
|
6848
|
+
'from'?: string | null;
|
|
6849
|
+
/**
|
|
6850
|
+
* Device ID
|
|
6851
|
+
*/
|
|
6852
|
+
'deviceId'?: string | null;
|
|
6853
|
+
}
|
|
6854
|
+
export declare const RequestDTOActionEnum: {
|
|
6855
|
+
readonly Drop: "drop";
|
|
6856
|
+
readonly Answer: "answer";
|
|
6857
|
+
readonly Divert: "divert";
|
|
6858
|
+
readonly Routeto: "routeto";
|
|
6859
|
+
readonly Transferto: "transferto";
|
|
6860
|
+
readonly AttachParticipantData: "attach_participant_data";
|
|
6861
|
+
readonly AttachPartyData: "attach_party_data";
|
|
6862
|
+
readonly Dial: "dial";
|
|
6863
|
+
};
|
|
6864
|
+
export type RequestDTOActionEnum = typeof RequestDTOActionEnum[keyof typeof RequestDTOActionEnum];
|
|
6808
6865
|
/**
|
|
6809
6866
|
* RMA Resolution Request Model
|
|
6810
6867
|
*/
|
|
@@ -6837,6 +6894,51 @@ export interface ResourceNotReadyException {
|
|
|
6837
6894
|
*/
|
|
6838
6895
|
'status': string;
|
|
6839
6896
|
}
|
|
6897
|
+
/**
|
|
6898
|
+
* 3CX Call Control Response
|
|
6899
|
+
*/
|
|
6900
|
+
export interface ResponseDTO {
|
|
6901
|
+
/**
|
|
6902
|
+
* ID
|
|
6903
|
+
*/
|
|
6904
|
+
'id': number;
|
|
6905
|
+
/**
|
|
6906
|
+
* Call ID
|
|
6907
|
+
*/
|
|
6908
|
+
'callId': number;
|
|
6909
|
+
/**
|
|
6910
|
+
* Type
|
|
6911
|
+
*/
|
|
6912
|
+
'type': ResponseDTOTypeEnum;
|
|
6913
|
+
/**
|
|
6914
|
+
* Number
|
|
6915
|
+
*/
|
|
6916
|
+
'number': string;
|
|
6917
|
+
/**
|
|
6918
|
+
* DN
|
|
6919
|
+
*/
|
|
6920
|
+
'dn': string;
|
|
6921
|
+
/**
|
|
6922
|
+
* Date Time
|
|
6923
|
+
*/
|
|
6924
|
+
'startedAt': string;
|
|
6925
|
+
/**
|
|
6926
|
+
* Device ID
|
|
6927
|
+
*/
|
|
6928
|
+
'account'?: AccountSummaryDTO | null;
|
|
6929
|
+
/**
|
|
6930
|
+
* Device
|
|
6931
|
+
*/
|
|
6932
|
+
'device'?: string | null;
|
|
6933
|
+
}
|
|
6934
|
+
export declare const ResponseDTOTypeEnum: {
|
|
6935
|
+
readonly Dialing: "dialing";
|
|
6936
|
+
readonly Ended: "ended";
|
|
6937
|
+
readonly Call: "call";
|
|
6938
|
+
readonly Ringing: "ringing";
|
|
6939
|
+
readonly Connected: "connected";
|
|
6940
|
+
};
|
|
6941
|
+
export type ResponseDTOTypeEnum = typeof ResponseDTOTypeEnum[keyof typeof ResponseDTOTypeEnum];
|
|
6840
6942
|
/**
|
|
6841
6943
|
* RMA Collection Request
|
|
6842
6944
|
*/
|
|
@@ -15356,6 +15458,12 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
|
|
|
15356
15458
|
* Class3CXApi - axios parameter creator
|
|
15357
15459
|
*/
|
|
15358
15460
|
export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15461
|
+
/**
|
|
15462
|
+
* Get a list of 3CX call control devices
|
|
15463
|
+
* @param {*} [options] Override http request option.
|
|
15464
|
+
* @throws {RequiredError}
|
|
15465
|
+
*/
|
|
15466
|
+
getGetCCDevices: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15359
15467
|
/**
|
|
15360
15468
|
* Get 3CX Licence Details
|
|
15361
15469
|
* @summary Get 3CX Licence Details
|
|
@@ -15405,6 +15513,12 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
15405
15513
|
* Class3CXApi - functional programming interface
|
|
15406
15514
|
*/
|
|
15407
15515
|
export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
15516
|
+
/**
|
|
15517
|
+
* Get a list of 3CX call control devices
|
|
15518
|
+
* @param {*} [options] Override http request option.
|
|
15519
|
+
* @throws {RequiredError}
|
|
15520
|
+
*/
|
|
15521
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DeviceModel>>>;
|
|
15408
15522
|
/**
|
|
15409
15523
|
* Get 3CX Licence Details
|
|
15410
15524
|
* @summary Get 3CX Licence Details
|
|
@@ -15454,6 +15568,12 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
|
15454
15568
|
* Class3CXApi - factory interface
|
|
15455
15569
|
*/
|
|
15456
15570
|
export declare const Class3CXApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15571
|
+
/**
|
|
15572
|
+
* Get a list of 3CX call control devices
|
|
15573
|
+
* @param {*} [options] Override http request option.
|
|
15574
|
+
* @throws {RequiredError}
|
|
15575
|
+
*/
|
|
15576
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): AxiosPromise<Array<DeviceModel>>;
|
|
15457
15577
|
/**
|
|
15458
15578
|
* Get 3CX Licence Details
|
|
15459
15579
|
* @summary Get 3CX Licence Details
|
|
@@ -15503,6 +15623,12 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
|
|
|
15503
15623
|
* Class3CXApi - object-oriented interface
|
|
15504
15624
|
*/
|
|
15505
15625
|
export declare class Class3CXApi extends BaseAPI {
|
|
15626
|
+
/**
|
|
15627
|
+
* Get a list of 3CX call control devices
|
|
15628
|
+
* @param {*} [options] Override http request option.
|
|
15629
|
+
* @throws {RequiredError}
|
|
15630
|
+
*/
|
|
15631
|
+
getGetCCDevices(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceModel[], any, {}, any>>;
|
|
15506
15632
|
/**
|
|
15507
15633
|
* Get 3CX Licence Details
|
|
15508
15634
|
* @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
|
|
@@ -473,11 +473,28 @@ exports.ReportRequestDTOGraphTypeEnum = {
|
|
|
473
473
|
StackedArea: 'stacked-area',
|
|
474
474
|
Table: 'table',
|
|
475
475
|
};
|
|
476
|
+
exports.RequestDTOActionEnum = {
|
|
477
|
+
Drop: 'drop',
|
|
478
|
+
Answer: 'answer',
|
|
479
|
+
Divert: 'divert',
|
|
480
|
+
Routeto: 'routeto',
|
|
481
|
+
Transferto: 'transferto',
|
|
482
|
+
AttachParticipantData: 'attach_participant_data',
|
|
483
|
+
AttachPartyData: 'attach_party_data',
|
|
484
|
+
Dial: 'dial',
|
|
485
|
+
};
|
|
476
486
|
exports.ResolutionRequestModelResolutionEnum = {
|
|
477
487
|
NUMBER_1: 1,
|
|
478
488
|
NUMBER_2: 2,
|
|
479
489
|
NUMBER_3: 3,
|
|
480
490
|
};
|
|
491
|
+
exports.ResponseDTOTypeEnum = {
|
|
492
|
+
Dialing: 'dialing',
|
|
493
|
+
Ended: 'ended',
|
|
494
|
+
Call: 'call',
|
|
495
|
+
Ringing: 'ringing',
|
|
496
|
+
Connected: 'connected',
|
|
497
|
+
};
|
|
481
498
|
exports.RmaCreditItemRequestDTORefundPercentageEnum = {
|
|
482
499
|
NUMBER_100: 100,
|
|
483
500
|
NUMBER_85: 85,
|
|
@@ -11629,6 +11646,39 @@ exports.GetGetCrmActivitiesTypeEnum = {
|
|
|
11629
11646
|
var Class3CXApiAxiosParamCreator = function (configuration) {
|
|
11630
11647
|
var _this = this;
|
|
11631
11648
|
return {
|
|
11649
|
+
/**
|
|
11650
|
+
* Get a list of 3CX call control devices
|
|
11651
|
+
* @param {*} [options] Override http request option.
|
|
11652
|
+
* @throws {RequiredError}
|
|
11653
|
+
*/
|
|
11654
|
+
getGetCCDevices: function () {
|
|
11655
|
+
var args_1 = [];
|
|
11656
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
11657
|
+
args_1[_i] = arguments[_i];
|
|
11658
|
+
}
|
|
11659
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
11660
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11661
|
+
if (options === void 0) { options = {}; }
|
|
11662
|
+
return __generator(this, function (_a) {
|
|
11663
|
+
localVarPath = "/tcx/cc/devices";
|
|
11664
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11665
|
+
if (configuration) {
|
|
11666
|
+
baseOptions = configuration.baseOptions;
|
|
11667
|
+
}
|
|
11668
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
11669
|
+
localVarHeaderParameter = {};
|
|
11670
|
+
localVarQueryParameter = {};
|
|
11671
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11672
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11673
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11674
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11675
|
+
return [2 /*return*/, {
|
|
11676
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11677
|
+
options: localVarRequestOptions,
|
|
11678
|
+
}];
|
|
11679
|
+
});
|
|
11680
|
+
});
|
|
11681
|
+
},
|
|
11632
11682
|
/**
|
|
11633
11683
|
* Get 3CX Licence Details
|
|
11634
11684
|
* @summary Get 3CX Licence Details
|
|
@@ -11851,6 +11901,27 @@ exports.Class3CXApiAxiosParamCreator = Class3CXApiAxiosParamCreator;
|
|
|
11851
11901
|
var Class3CXApiFp = function (configuration) {
|
|
11852
11902
|
var localVarAxiosParamCreator = (0, exports.Class3CXApiAxiosParamCreator)(configuration);
|
|
11853
11903
|
return {
|
|
11904
|
+
/**
|
|
11905
|
+
* Get a list of 3CX call control devices
|
|
11906
|
+
* @param {*} [options] Override http request option.
|
|
11907
|
+
* @throws {RequiredError}
|
|
11908
|
+
*/
|
|
11909
|
+
getGetCCDevices: function (options) {
|
|
11910
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11911
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11912
|
+
var _a, _b, _c;
|
|
11913
|
+
return __generator(this, function (_d) {
|
|
11914
|
+
switch (_d.label) {
|
|
11915
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCCDevices(options)];
|
|
11916
|
+
case 1:
|
|
11917
|
+
localVarAxiosArgs = _d.sent();
|
|
11918
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11919
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetCCDevices']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11920
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11921
|
+
}
|
|
11922
|
+
});
|
|
11923
|
+
});
|
|
11924
|
+
},
|
|
11854
11925
|
/**
|
|
11855
11926
|
* Get 3CX Licence Details
|
|
11856
11927
|
* @summary Get 3CX Licence Details
|
|
@@ -11994,6 +12065,14 @@ exports.Class3CXApiFp = Class3CXApiFp;
|
|
|
11994
12065
|
var Class3CXApiFactory = function (configuration, basePath, axios) {
|
|
11995
12066
|
var localVarFp = (0, exports.Class3CXApiFp)(configuration);
|
|
11996
12067
|
return {
|
|
12068
|
+
/**
|
|
12069
|
+
* Get a list of 3CX call control devices
|
|
12070
|
+
* @param {*} [options] Override http request option.
|
|
12071
|
+
* @throws {RequiredError}
|
|
12072
|
+
*/
|
|
12073
|
+
getGetCCDevices: function (options) {
|
|
12074
|
+
return localVarFp.getGetCCDevices(options).then(function (request) { return request(axios, basePath); });
|
|
12075
|
+
},
|
|
11997
12076
|
/**
|
|
11998
12077
|
* Get 3CX Licence Details
|
|
11999
12078
|
* @summary Get 3CX Licence Details
|
|
@@ -12061,6 +12140,15 @@ var Class3CXApi = /** @class */ (function (_super) {
|
|
|
12061
12140
|
function Class3CXApi() {
|
|
12062
12141
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
12063
12142
|
}
|
|
12143
|
+
/**
|
|
12144
|
+
* Get a list of 3CX call control devices
|
|
12145
|
+
* @param {*} [options] Override http request option.
|
|
12146
|
+
* @throws {RequiredError}
|
|
12147
|
+
*/
|
|
12148
|
+
Class3CXApi.prototype.getGetCCDevices = function (options) {
|
|
12149
|
+
var _this = this;
|
|
12150
|
+
return (0, exports.Class3CXApiFp)(this.configuration).getGetCCDevices(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12151
|
+
};
|
|
12064
12152
|
/**
|
|
12065
12153
|
* Get 3CX Licence Details
|
|
12066
12154
|
* @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)
|