yellowgrid-api-ts 3.2.344 → 3.2.346

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.
@@ -391,6 +391,7 @@ docs/TcxSbcDTO.md
391
391
  docs/TcxSbcEntity.md
392
392
  docs/TcxSbcModel.md
393
393
  docs/TcxSbcResponseDTO.md
394
+ docs/TcxServicePrincipalEntity.md
394
395
  docs/TcxSetupEntity.md
395
396
  docs/TcxSetupsModel.md
396
397
  docs/TcxSipTrunksEntity.md
package/README.md CHANGED
@@ -183,10 +183,12 @@ Class | Method | HTTP request | Description
183
183
  *CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal |
184
184
  *Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices |
185
185
  *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
186
+ *Class3CXApi* | [**getGetServicePrincipals**](docs/Class3CXApi.md#getgetserviceprincipals) | **GET** /tcx/cc/services |
186
187
  *Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
187
188
  *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
188
189
  *Class3CXApi* | [**getGetTcxExpiringKeysCsv**](docs/Class3CXApi.md#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
189
190
  *Class3CXApi* | [**getGetTcxPartners**](docs/Class3CXApi.md#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners
191
+ *Class3CXApi* | [**postAuthenticateInstanceWebsocket**](docs/Class3CXApi.md#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} |
190
192
  *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
191
193
  *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
192
194
  *Class3CXInstallationWizardApi* | [**deleteAddNumbers**](docs/Class3CXInstallationWizardApi.md#deleteaddnumbers) | **DELETE** /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers
@@ -813,6 +815,7 @@ Class | Method | HTTP request | Description
813
815
  - [TcxSbcEntity](docs/TcxSbcEntity.md)
814
816
  - [TcxSbcModel](docs/TcxSbcModel.md)
815
817
  - [TcxSbcResponseDTO](docs/TcxSbcResponseDTO.md)
818
+ - [TcxServicePrincipalEntity](docs/TcxServicePrincipalEntity.md)
816
819
  - [TcxSetupEntity](docs/TcxSetupEntity.md)
817
820
  - [TcxSetupsModel](docs/TcxSetupsModel.md)
818
821
  - [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)
package/api.ts CHANGED
@@ -1350,6 +1350,7 @@ export const AuditLogEntityTypeEnum = {
1350
1350
  Pops3cxSetup: 'pops_3cx_setup',
1351
1351
  Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
1352
1352
  Pops3cxUsers: 'pops_3cx_users',
1353
+ _3cxServicePrincipals: '3cx_service_principals',
1353
1354
  PopsUsers: 'pops_users',
1354
1355
  PopsVideoRequests: 'pops_video_requests',
1355
1356
  Webhook: 'webhook',
@@ -10841,6 +10842,27 @@ export interface TcxSbcResponseDTO {
10841
10842
  */
10842
10843
  'message': string;
10843
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
+ }
10844
10866
  /**
10845
10867
  * 3CX Wizard Setup Config
10846
10868
  */
@@ -20742,6 +20764,35 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
20742
20764
  options: localVarRequestOptions,
20743
20765
  };
20744
20766
  },
20767
+ /**
20768
+ * Get 3CX service principals
20769
+ * @param {*} [options] Override http request option.
20770
+ * @throws {RequiredError}
20771
+ */
20772
+ getGetServicePrincipals: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20773
+ const localVarPath = `/tcx/cc/services`;
20774
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20775
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20776
+ let baseOptions;
20777
+ if (configuration) {
20778
+ baseOptions = configuration.baseOptions;
20779
+ }
20780
+
20781
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20782
+ const localVarHeaderParameter = {} as any;
20783
+ const localVarQueryParameter = {} as any;
20784
+
20785
+ localVarHeaderParameter['Accept'] = 'application/json';
20786
+
20787
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20788
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20789
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20790
+
20791
+ return {
20792
+ url: toPathString(localVarUrlObj),
20793
+ options: localVarRequestOptions,
20794
+ };
20795
+ },
20745
20796
  /**
20746
20797
  * Get 3CX Credit Status
20747
20798
  * @summary Get 3CX Credit Status
@@ -20853,6 +20904,38 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
20853
20904
 
20854
20905
  localVarHeaderParameter['Accept'] = 'application/json';
20855
20906
 
20907
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20908
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20909
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20910
+
20911
+ return {
20912
+ url: toPathString(localVarUrlObj),
20913
+ options: localVarRequestOptions,
20914
+ };
20915
+ },
20916
+ /**
20917
+ * Get 3CX service principals
20918
+ * @param {string} id Instance ID
20919
+ * @param {*} [options] Override http request option.
20920
+ * @throws {RequiredError}
20921
+ */
20922
+ postAuthenticateInstanceWebsocket: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20923
+ // verify required parameter 'id' is not null or undefined
20924
+ assertParamExists('postAuthenticateInstanceWebsocket', 'id', id)
20925
+ const localVarPath = `/tcx/cc/instance/auth/{id}`
20926
+ .replace('{id}', encodeURIComponent(String(id)));
20927
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20928
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20929
+ let baseOptions;
20930
+ if (configuration) {
20931
+ baseOptions = configuration.baseOptions;
20932
+ }
20933
+
20934
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
20935
+ const localVarHeaderParameter = {} as any;
20936
+ const localVarQueryParameter = {} as any;
20937
+
20938
+
20856
20939
  setSearchParams(localVarUrlObj, localVarQueryParameter);
20857
20940
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20858
20941
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -20928,6 +21011,17 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
20928
21011
  const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetLicenceDetails']?.[localVarOperationServerIndex]?.url;
20929
21012
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
20930
21013
  },
21014
+ /**
21015
+ * Get 3CX service principals
21016
+ * @param {*} [options] Override http request option.
21017
+ * @throws {RequiredError}
21018
+ */
21019
+ async getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>> {
21020
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetServicePrincipals(options);
21021
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21022
+ const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetServicePrincipals']?.[localVarOperationServerIndex]?.url;
21023
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21024
+ },
20931
21025
  /**
20932
21026
  * Get 3CX Credit Status
20933
21027
  * @summary Get 3CX Credit Status
@@ -20976,6 +21070,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
20976
21070
  const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
20977
21071
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
20978
21072
  },
21073
+ /**
21074
+ * Get 3CX service principals
21075
+ * @param {string} id Instance ID
21076
+ * @param {*} [options] Override http request option.
21077
+ * @throws {RequiredError}
21078
+ */
21079
+ async postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21080
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postAuthenticateInstanceWebsocket(id, options);
21081
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21082
+ const localVarOperationServerBasePath = operationServerMap['Class3CXApi.postAuthenticateInstanceWebsocket']?.[localVarOperationServerIndex]?.url;
21083
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21084
+ },
20979
21085
  /**
20980
21086
  * Get Bulk 3CX Licence Details
20981
21087
  * @summary Get bulk 3CX Licence Details
@@ -21016,6 +21122,14 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
21016
21122
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel> {
21017
21123
  return localVarFp.getGetLicenceDetails(key, options).then((request) => request(axios, basePath));
21018
21124
  },
21125
+ /**
21126
+ * Get 3CX service principals
21127
+ * @param {*} [options] Override http request option.
21128
+ * @throws {RequiredError}
21129
+ */
21130
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>> {
21131
+ return localVarFp.getGetServicePrincipals(options).then((request) => request(axios, basePath));
21132
+ },
21019
21133
  /**
21020
21134
  * Get 3CX Credit Status
21021
21135
  * @summary Get 3CX Credit Status
@@ -21052,6 +21166,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
21052
21166
  getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>> {
21053
21167
  return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
21054
21168
  },
21169
+ /**
21170
+ * Get 3CX service principals
21171
+ * @param {string} id Instance ID
21172
+ * @param {*} [options] Override http request option.
21173
+ * @throws {RequiredError}
21174
+ */
21175
+ postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21176
+ return localVarFp.postAuthenticateInstanceWebsocket(id, options).then((request) => request(axios, basePath));
21177
+ },
21055
21178
  /**
21056
21179
  * Get Bulk 3CX Licence Details
21057
21180
  * @summary Get bulk 3CX Licence Details
@@ -21089,6 +21212,15 @@ export class Class3CXApi extends BaseAPI {
21089
21212
  return Class3CXApiFp(this.configuration).getGetLicenceDetails(key, options).then((request) => request(this.axios, this.basePath));
21090
21213
  }
21091
21214
 
21215
+ /**
21216
+ * Get 3CX service principals
21217
+ * @param {*} [options] Override http request option.
21218
+ * @throws {RequiredError}
21219
+ */
21220
+ public getGetServicePrincipals(options?: RawAxiosRequestConfig) {
21221
+ return Class3CXApiFp(this.configuration).getGetServicePrincipals(options).then((request) => request(this.axios, this.basePath));
21222
+ }
21223
+
21092
21224
  /**
21093
21225
  * Get 3CX Credit Status
21094
21226
  * @summary Get 3CX Credit Status
@@ -21129,6 +21261,16 @@ export class Class3CXApi extends BaseAPI {
21129
21261
  return Class3CXApiFp(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
21130
21262
  }
21131
21263
 
21264
+ /**
21265
+ * Get 3CX service principals
21266
+ * @param {string} id Instance ID
21267
+ * @param {*} [options] Override http request option.
21268
+ * @throws {RequiredError}
21269
+ */
21270
+ public postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig) {
21271
+ return Class3CXApiFp(this.configuration).postAuthenticateInstanceWebsocket(id, options).then((request) => request(this.axios, this.basePath));
21272
+ }
21273
+
21132
21274
  /**
21133
21275
  * Get Bulk 3CX Licence Details
21134
21276
  * @summary Get bulk 3CX Licence Details
package/dist/api.d.ts CHANGED
@@ -1317,6 +1317,7 @@ export declare const AuditLogEntityTypeEnum: {
1317
1317
  readonly Pops3cxSetup: "pops_3cx_setup";
1318
1318
  readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
1319
1319
  readonly Pops3cxUsers: "pops_3cx_users";
1320
+ readonly _3cxServicePrincipals: "3cx_service_principals";
1320
1321
  readonly PopsUsers: "pops_users";
1321
1322
  readonly PopsVideoRequests: "pops_video_requests";
1322
1323
  readonly Webhook: "webhook";
@@ -10645,6 +10646,27 @@ export interface TcxSbcResponseDTO {
10645
10646
  */
10646
10647
  'message': string;
10647
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
+ }
10648
10670
  /**
10649
10671
  * 3CX Wizard Setup Config
10650
10672
  */
@@ -15472,6 +15494,12 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
15472
15494
  * @throws {RequiredError}
15473
15495
  */
15474
15496
  getGetLicenceDetails: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15497
+ /**
15498
+ * Get 3CX service principals
15499
+ * @param {*} [options] Override http request option.
15500
+ * @throws {RequiredError}
15501
+ */
15502
+ getGetServicePrincipals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15475
15503
  /**
15476
15504
  * Get 3CX Credit Status
15477
15505
  * @summary Get 3CX Credit Status
@@ -15500,6 +15528,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
15500
15528
  * @throws {RequiredError}
15501
15529
  */
15502
15530
  getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15531
+ /**
15532
+ * Get 3CX service principals
15533
+ * @param {string} id Instance ID
15534
+ * @param {*} [options] Override http request option.
15535
+ * @throws {RequiredError}
15536
+ */
15537
+ postAuthenticateInstanceWebsocket: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15503
15538
  /**
15504
15539
  * Get Bulk 3CX Licence Details
15505
15540
  * @summary Get bulk 3CX Licence Details
@@ -15527,6 +15562,12 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
15527
15562
  * @throws {RequiredError}
15528
15563
  */
15529
15564
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxLicenceDetailsModel>>;
15565
+ /**
15566
+ * Get 3CX service principals
15567
+ * @param {*} [options] Override http request option.
15568
+ * @throws {RequiredError}
15569
+ */
15570
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>>;
15530
15571
  /**
15531
15572
  * Get 3CX Credit Status
15532
15573
  * @summary Get 3CX Credit Status
@@ -15555,6 +15596,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
15555
15596
  * @throws {RequiredError}
15556
15597
  */
15557
15598
  getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
15599
+ /**
15600
+ * Get 3CX service principals
15601
+ * @param {string} id Instance ID
15602
+ * @param {*} [options] Override http request option.
15603
+ * @throws {RequiredError}
15604
+ */
15605
+ postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15558
15606
  /**
15559
15607
  * Get Bulk 3CX Licence Details
15560
15608
  * @summary Get bulk 3CX Licence Details
@@ -15582,6 +15630,12 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
15582
15630
  * @throws {RequiredError}
15583
15631
  */
15584
15632
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel>;
15633
+ /**
15634
+ * Get 3CX service principals
15635
+ * @param {*} [options] Override http request option.
15636
+ * @throws {RequiredError}
15637
+ */
15638
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>>;
15585
15639
  /**
15586
15640
  * Get 3CX Credit Status
15587
15641
  * @summary Get 3CX Credit Status
@@ -15610,6 +15664,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
15610
15664
  * @throws {RequiredError}
15611
15665
  */
15612
15666
  getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
15667
+ /**
15668
+ * Get 3CX service principals
15669
+ * @param {string} id Instance ID
15670
+ * @param {*} [options] Override http request option.
15671
+ * @throws {RequiredError}
15672
+ */
15673
+ postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15613
15674
  /**
15614
15675
  * Get Bulk 3CX Licence Details
15615
15676
  * @summary Get bulk 3CX Licence Details
@@ -15637,6 +15698,12 @@ export declare class Class3CXApi extends BaseAPI {
15637
15698
  * @throws {RequiredError}
15638
15699
  */
15639
15700
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxLicenceDetailsModel, any, {}, any>>;
15701
+ /**
15702
+ * Get 3CX service principals
15703
+ * @param {*} [options] Override http request option.
15704
+ * @throws {RequiredError}
15705
+ */
15706
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxServicePrincipalEntity[], any, {}, any>>;
15640
15707
  /**
15641
15708
  * Get 3CX Credit Status
15642
15709
  * @summary Get 3CX Credit Status
@@ -15665,6 +15732,13 @@ export declare class Class3CXApi extends BaseAPI {
15665
15732
  * @throws {RequiredError}
15666
15733
  */
15667
15734
  getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDTO[], any, {}, any>>;
15735
+ /**
15736
+ * Get 3CX service principals
15737
+ * @param {string} id Instance ID
15738
+ * @param {*} [options] Override http request option.
15739
+ * @throws {RequiredError}
15740
+ */
15741
+ postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
15668
15742
  /**
15669
15743
  * Get Bulk 3CX Licence Details
15670
15744
  * @summary Get bulk 3CX Licence Details
package/dist/api.js CHANGED
@@ -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',
@@ -11719,6 +11720,39 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
11719
11720
  });
11720
11721
  });
11721
11722
  },
11723
+ /**
11724
+ * Get 3CX service principals
11725
+ * @param {*} [options] Override http request option.
11726
+ * @throws {RequiredError}
11727
+ */
11728
+ getGetServicePrincipals: function () {
11729
+ var args_1 = [];
11730
+ for (var _i = 0; _i < arguments.length; _i++) {
11731
+ args_1[_i] = arguments[_i];
11732
+ }
11733
+ return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
11734
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
11735
+ if (options === void 0) { options = {}; }
11736
+ return __generator(this, function (_a) {
11737
+ localVarPath = "/tcx/cc/services";
11738
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
11739
+ if (configuration) {
11740
+ baseOptions = configuration.baseOptions;
11741
+ }
11742
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
11743
+ localVarHeaderParameter = {};
11744
+ localVarQueryParameter = {};
11745
+ localVarHeaderParameter['Accept'] = 'application/json';
11746
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
11747
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11748
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11749
+ return [2 /*return*/, {
11750
+ url: (0, common_1.toPathString)(localVarUrlObj),
11751
+ options: localVarRequestOptions,
11752
+ }];
11753
+ });
11754
+ });
11755
+ },
11722
11756
  /**
11723
11757
  * Get 3CX Credit Status
11724
11758
  * @summary Get 3CX Credit Status
@@ -11855,6 +11889,42 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
11855
11889
  });
11856
11890
  });
11857
11891
  },
11892
+ /**
11893
+ * Get 3CX service principals
11894
+ * @param {string} id Instance ID
11895
+ * @param {*} [options] Override http request option.
11896
+ * @throws {RequiredError}
11897
+ */
11898
+ postAuthenticateInstanceWebsocket: function (id_1) {
11899
+ var args_1 = [];
11900
+ for (var _i = 1; _i < arguments.length; _i++) {
11901
+ args_1[_i - 1] = arguments[_i];
11902
+ }
11903
+ return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
11904
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
11905
+ if (options === void 0) { options = {}; }
11906
+ return __generator(this, function (_a) {
11907
+ // verify required parameter 'id' is not null or undefined
11908
+ (0, common_1.assertParamExists)('postAuthenticateInstanceWebsocket', 'id', id);
11909
+ localVarPath = "/tcx/cc/instance/auth/{id}"
11910
+ .replace('{id}', encodeURIComponent(String(id)));
11911
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
11912
+ if (configuration) {
11913
+ baseOptions = configuration.baseOptions;
11914
+ }
11915
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
11916
+ localVarHeaderParameter = {};
11917
+ localVarQueryParameter = {};
11918
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
11919
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11920
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11921
+ return [2 /*return*/, {
11922
+ url: (0, common_1.toPathString)(localVarUrlObj),
11923
+ options: localVarRequestOptions,
11924
+ }];
11925
+ });
11926
+ });
11927
+ },
11858
11928
  /**
11859
11929
  * Get Bulk 3CX Licence Details
11860
11930
  * @summary Get bulk 3CX Licence Details
@@ -11945,6 +12015,27 @@ var Class3CXApiFp = function (configuration) {
11945
12015
  });
11946
12016
  });
11947
12017
  },
12018
+ /**
12019
+ * Get 3CX service principals
12020
+ * @param {*} [options] Override http request option.
12021
+ * @throws {RequiredError}
12022
+ */
12023
+ getGetServicePrincipals: function (options) {
12024
+ return __awaiter(this, void 0, void 0, function () {
12025
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
12026
+ var _a, _b, _c;
12027
+ return __generator(this, function (_d) {
12028
+ switch (_d.label) {
12029
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetServicePrincipals(options)];
12030
+ case 1:
12031
+ localVarAxiosArgs = _d.sent();
12032
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
12033
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetServicePrincipals']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
12034
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
12035
+ }
12036
+ });
12037
+ });
12038
+ },
11948
12039
  /**
11949
12040
  * Get 3CX Credit Status
11950
12041
  * @summary Get 3CX Credit Status
@@ -12033,6 +12124,28 @@ var Class3CXApiFp = function (configuration) {
12033
12124
  });
12034
12125
  });
12035
12126
  },
12127
+ /**
12128
+ * Get 3CX service principals
12129
+ * @param {string} id Instance ID
12130
+ * @param {*} [options] Override http request option.
12131
+ * @throws {RequiredError}
12132
+ */
12133
+ postAuthenticateInstanceWebsocket: function (id, options) {
12134
+ return __awaiter(this, void 0, void 0, function () {
12135
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
12136
+ var _a, _b, _c;
12137
+ return __generator(this, function (_d) {
12138
+ switch (_d.label) {
12139
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAuthenticateInstanceWebsocket(id, options)];
12140
+ case 1:
12141
+ localVarAxiosArgs = _d.sent();
12142
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
12143
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.postAuthenticateInstanceWebsocket']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
12144
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
12145
+ }
12146
+ });
12147
+ });
12148
+ },
12036
12149
  /**
12037
12150
  * Get Bulk 3CX Licence Details
12038
12151
  * @summary Get bulk 3CX Licence Details
@@ -12083,6 +12196,14 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
12083
12196
  getGetLicenceDetails: function (key, options) {
12084
12197
  return localVarFp.getGetLicenceDetails(key, options).then(function (request) { return request(axios, basePath); });
12085
12198
  },
12199
+ /**
12200
+ * Get 3CX service principals
12201
+ * @param {*} [options] Override http request option.
12202
+ * @throws {RequiredError}
12203
+ */
12204
+ getGetServicePrincipals: function (options) {
12205
+ return localVarFp.getGetServicePrincipals(options).then(function (request) { return request(axios, basePath); });
12206
+ },
12086
12207
  /**
12087
12208
  * Get 3CX Credit Status
12088
12209
  * @summary Get 3CX Credit Status
@@ -12119,6 +12240,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
12119
12240
  getGetTcxPartners: function (options) {
12120
12241
  return localVarFp.getGetTcxPartners(options).then(function (request) { return request(axios, basePath); });
12121
12242
  },
12243
+ /**
12244
+ * Get 3CX service principals
12245
+ * @param {string} id Instance ID
12246
+ * @param {*} [options] Override http request option.
12247
+ * @throws {RequiredError}
12248
+ */
12249
+ postAuthenticateInstanceWebsocket: function (id, options) {
12250
+ return localVarFp.postAuthenticateInstanceWebsocket(id, options).then(function (request) { return request(axios, basePath); });
12251
+ },
12122
12252
  /**
12123
12253
  * Get Bulk 3CX Licence Details
12124
12254
  * @summary Get bulk 3CX Licence Details
@@ -12160,6 +12290,15 @@ var Class3CXApi = /** @class */ (function (_super) {
12160
12290
  var _this = this;
12161
12291
  return (0, exports.Class3CXApiFp)(this.configuration).getGetLicenceDetails(key, options).then(function (request) { return request(_this.axios, _this.basePath); });
12162
12292
  };
12293
+ /**
12294
+ * Get 3CX service principals
12295
+ * @param {*} [options] Override http request option.
12296
+ * @throws {RequiredError}
12297
+ */
12298
+ Class3CXApi.prototype.getGetServicePrincipals = function (options) {
12299
+ var _this = this;
12300
+ return (0, exports.Class3CXApiFp)(this.configuration).getGetServicePrincipals(options).then(function (request) { return request(_this.axios, _this.basePath); });
12301
+ };
12163
12302
  /**
12164
12303
  * Get 3CX Credit Status
12165
12304
  * @summary Get 3CX Credit Status
@@ -12200,6 +12339,16 @@ var Class3CXApi = /** @class */ (function (_super) {
12200
12339
  var _this = this;
12201
12340
  return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then(function (request) { return request(_this.axios, _this.basePath); });
12202
12341
  };
12342
+ /**
12343
+ * Get 3CX service principals
12344
+ * @param {string} id Instance ID
12345
+ * @param {*} [options] Override http request option.
12346
+ * @throws {RequiredError}
12347
+ */
12348
+ Class3CXApi.prototype.postAuthenticateInstanceWebsocket = function (id, options) {
12349
+ var _this = this;
12350
+ return (0, exports.Class3CXApiFp)(this.configuration).postAuthenticateInstanceWebsocket(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
12351
+ };
12203
12352
  /**
12204
12353
  * Get Bulk 3CX Licence Details
12205
12354
  * @summary Get bulk 3CX Licence Details
@@ -6,10 +6,12 @@ All URIs are relative to *https://bitbucket.org*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetCCDevices**](#getgetccdevices) | **GET** /tcx/cc/devices | |
8
8
  |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
9
+ |[**getGetServicePrincipals**](#getgetserviceprincipals) | **GET** /tcx/cc/services | |
9
10
  |[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
10
11
  |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
11
12
  |[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
12
13
  |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
14
+ |[**postAuthenticateInstanceWebsocket**](#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} | |
13
15
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
14
16
 
15
17
  # **getGetCCDevices**
@@ -113,6 +115,53 @@ No authorization required
113
115
 
114
116
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
115
117
 
118
+ # **getGetServicePrincipals**
119
+ > Array<TcxServicePrincipalEntity> getGetServicePrincipals()
120
+
121
+ Get 3CX service principals
122
+
123
+ ### Example
124
+
125
+ ```typescript
126
+ import {
127
+ Class3CXApi,
128
+ Configuration
129
+ } from 'yellowgrid-api-ts';
130
+
131
+ const configuration = new Configuration();
132
+ const apiInstance = new Class3CXApi(configuration);
133
+
134
+ const { status, data } = await apiInstance.getGetServicePrincipals();
135
+ ```
136
+
137
+ ### Parameters
138
+ This endpoint does not have any parameters.
139
+
140
+
141
+ ### Return type
142
+
143
+ **Array<TcxServicePrincipalEntity>**
144
+
145
+ ### Authorization
146
+
147
+ No authorization required
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+
154
+
155
+ ### HTTP response details
156
+ | Status code | Description | Response headers |
157
+ |-------------|-------------|------------------|
158
+ |**200** | Service Principals | - |
159
+ |**400** | Bad Request | - |
160
+ |**401** | Unauthorised | - |
161
+ |**403** | Access Denied | - |
162
+
163
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
164
+
116
165
  # **getGetTcxCreditStatus**
117
166
  > CreditStatusDTO getGetTcxCreditStatus()
118
167
 
@@ -301,6 +350,60 @@ No authorization required
301
350
 
302
351
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
303
352
 
353
+ # **postAuthenticateInstanceWebsocket**
354
+ > postAuthenticateInstanceWebsocket()
355
+
356
+ Get 3CX service principals
357
+
358
+ ### Example
359
+
360
+ ```typescript
361
+ import {
362
+ Class3CXApi,
363
+ Configuration
364
+ } from 'yellowgrid-api-ts';
365
+
366
+ const configuration = new Configuration();
367
+ const apiInstance = new Class3CXApi(configuration);
368
+
369
+ let id: string; //Instance ID (default to undefined)
370
+
371
+ const { status, data } = await apiInstance.postAuthenticateInstanceWebsocket(
372
+ id
373
+ );
374
+ ```
375
+
376
+ ### Parameters
377
+
378
+ |Name | Type | Description | Notes|
379
+ |------------- | ------------- | ------------- | -------------|
380
+ | **id** | [**string**] | Instance ID | defaults to undefined|
381
+
382
+
383
+ ### Return type
384
+
385
+ void (empty response body)
386
+
387
+ ### Authorization
388
+
389
+ No authorization required
390
+
391
+ ### HTTP request headers
392
+
393
+ - **Content-Type**: Not defined
394
+ - **Accept**: Not defined
395
+
396
+
397
+ ### HTTP response details
398
+ | Status code | Description | Response headers |
399
+ |-------------|-------------|------------------|
400
+ |**200** | No Response | - |
401
+ |**400** | Bad Request | - |
402
+ |**401** | Unauthorised | - |
403
+ |**403** | Access Denied | - |
404
+
405
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
406
+
304
407
  # **postGetBulkLicenceDetails**
305
408
  > TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
306
409
 
@@ -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)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.344",
3
+ "version": "3.2.346",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {