yellowgrid-api-ts 3.2.342 → 3.2.344

package/.openapi-generator/FILES

@@ -101,6 +101,7 @@ docs/DdiRangeRequestModel.md
 docs/DdiRangesRequestModel.md
 docs/DetailedItemRequestDTO.md
 docs/DetailedOrderRequestDTO.md
+docs/DeviceModel.md
 docs/DivertRequestModel.md
 docs/DivertResponseModel.md
 docs/EdTechProClientEntity.md
@@ -260,8 +261,10 @@ docs/RecurringCharge.md
 docs/RemoteStorageDTO.md
 docs/ReportRequestDTO.md
 docs/ReportsApi.md
+docs/RequestDTO.md
 docs/ResolutionRequestModel.md
 docs/ResourceNotReadyException.md
+docs/ResponseDTO.md
 docs/RmaCollectionDTO.md
 docs/RmaCreditItemRequestDTO.md
 docs/RmaDTO.md

package/README.md

@@ -181,6 +181,7 @@ Class | Method | HTTP request | Description
 *CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search | 
 *CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | 
 *CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal | 
+*Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices | 
 *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
 *Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
 *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
@@ -541,6 +542,7 @@ Class | Method | HTTP request | Description
  - [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
  - [DetailedItemRequestDTO](docs/DetailedItemRequestDTO.md)
  - [DetailedOrderRequestDTO](docs/DetailedOrderRequestDTO.md)
+ - [DeviceModel](docs/DeviceModel.md)
  - [DivertRequestModel](docs/DivertRequestModel.md)
  - [DivertResponseModel](docs/DivertResponseModel.md)
  - [EdTechProClientEntity](docs/EdTechProClientEntity.md)
@@ -688,8 +690,10 @@ Class | Method | HTTP request | Description
  - [RecurringCharge](docs/RecurringCharge.md)
  - [RemoteStorageDTO](docs/RemoteStorageDTO.md)
  - [ReportRequestDTO](docs/ReportRequestDTO.md)
+ - [RequestDTO](docs/RequestDTO.md)
  - [ResolutionRequestModel](docs/ResolutionRequestModel.md)
  - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
+ - [ResponseDTO](docs/ResponseDTO.md)
  - [RmaCollectionDTO](docs/RmaCollectionDTO.md)
  - [RmaCreditItemRequestDTO](docs/RmaCreditItemRequestDTO.md)
  - [RmaDTO](docs/RmaDTO.md)

package/api.ts

@@ -1053,6 +1053,10 @@ export interface AdminUserModel {
      * Groups
      */
     'permissions': Array<AdminUserModelPermissionsEnum>;
+    /**
+     * Extension Number
+     */
+    'extNo': number;
 }
 
 export const AdminUserModelRoleEnum = {
@@ -3014,6 +3018,23 @@ export interface DetailedOrderRequestDTO {
      */
     'quote': boolean;
 }
+/**
+ * 3CX Call Control Device
+ */
+export interface DeviceModel {
+    /**
+     * DN
+     */
+    'dn'?: string | null;
+    /**
+     * Device ID
+     */
+    'deviceId'?: string | null;
+    /**
+     * User Agent
+     */
+    'userAgent'?: string | null;
+}
 /**
  * Divert Request
  */
@@ -6914,6 +6935,45 @@ export const ReportRequestDTOGraphTypeEnum = {
 
 export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
 
+/**
+ * 3CX Call Control Request
+ */
+export interface RequestDTO {
+    /**
+     * ID
+     */
+    'id'?: number | null;
+    /**
+     * Action
+     */
+    'action': RequestDTOActionEnum;
+    /**
+     * Number
+     */
+    'number'?: string | null;
+    /**
+     * From
+     */
+    'from'?: string | null;
+    /**
+     * Device ID
+     */
+    'deviceId'?: string | null;
+}
+
+export const RequestDTOActionEnum = {
+    Drop: 'drop',
+    Answer: 'answer',
+    Divert: 'divert',
+    Routeto: 'routeto',
+    Transferto: 'transferto',
+    AttachParticipantData: 'attach_participant_data',
+    AttachPartyData: 'attach_party_data',
+    Dial: 'dial',
+} as const;
+
+export type RequestDTOActionEnum = typeof RequestDTOActionEnum[keyof typeof RequestDTOActionEnum];
+
 /**
  * RMA Resolution Request Model
  */
@@ -6949,6 +7009,54 @@ export interface ResourceNotReadyException {
      */
     'status': string;
 }
+/**
+ * 3CX Call Control Response
+ */
+export interface ResponseDTO {
+    /**
+     * ID
+     */
+    'id': number;
+    /**
+     * Call ID
+     */
+    'callId': number;
+    /**
+     * Type
+     */
+    'type': ResponseDTOTypeEnum;
+    /**
+     * Number
+     */
+    'number': string;
+    /**
+     * DN
+     */
+    'dn': string;
+    /**
+     * Date Time
+     */
+    'startedAt': string;
+    /**
+     * Device ID
+     */
+    'account'?: AccountSummaryDTO | null;
+    /**
+     * Device
+     */
+    'device'?: string | null;
+}
+
+export const ResponseDTOTypeEnum = {
+    Dialing: 'dialing',
+    Ended: 'ended',
+    Call: 'call',
+    Ringing: 'ringing',
+    Connected: 'connected',
+} as const;
+
+export type ResponseDTOTypeEnum = typeof ResponseDTOTypeEnum[keyof typeof ResponseDTOTypeEnum];
+
 /**
  * RMA Collection Request
  */
@@ -20568,6 +20676,35 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
  */
 export const Class3CXApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Get a list of 3CX call control devices
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCCDevices: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/tcx/cc/devices`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get 3CX Licence Details
          * @summary Get 3CX Licence Details
@@ -20767,6 +20904,17 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
 export const Class3CXApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = Class3CXApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Get a list of 3CX call control devices
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetCCDevices(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DeviceModel>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCCDevices(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetCCDevices']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get 3CX Licence Details
          * @summary Get 3CX Licence Details
@@ -20850,6 +20998,14 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
 export const Class3CXApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = Class3CXApiFp(configuration)
     return {
+        /**
+         * Get a list of 3CX call control devices
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCCDevices(options?: RawAxiosRequestConfig): AxiosPromise<Array<DeviceModel>> {
+            return localVarFp.getGetCCDevices(options).then((request) => request(axios, basePath));
+        },
         /**
          * Get 3CX Licence Details
          * @summary Get 3CX Licence Details
@@ -20913,6 +21069,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
  * Class3CXApi - object-oriented interface
  */
 export class Class3CXApi extends BaseAPI {
+    /**
+     * Get a list of 3CX call control devices
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetCCDevices(options?: RawAxiosRequestConfig) {
+        return Class3CXApiFp(this.configuration).getGetCCDevices(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get 3CX Licence Details
      * @summary Get 3CX Licence Details

package/config.json

@@ -1,4 +1,4 @@
 {
   "npmName": "yellowgrid-api-ts",
-  "axiosVersion": "1.18.1"
+  "axiosVersion": "1.20.0"
 }