yellowgrid-api-ts 3.2.90 → 3.2.91
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 +1 -1
- package/README.md +4 -1
- package/api.ts +248 -63
- package/dist/api.d.ts +136 -62
- package/dist/api.js +261 -6
- package/docs/Class3CXInstallationsApi.md +175 -4
- package/docs/RemoteStorageDTO.md +27 -0
- package/package.json +1 -1
- package/docs/TcxInstallationDetailsModel.md +0 -45
package/dist/api.js
CHANGED
|
@@ -5506,7 +5506,7 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
5506
5506
|
* @summary Extend additional disk on 3CX Instance
|
|
5507
5507
|
* @param {string} instanceId Instance ID
|
|
5508
5508
|
* @param {number} gigabytes Disk Space (GB)
|
|
5509
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
5509
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
5510
5510
|
* @param {*} [options] Override http request option.
|
|
5511
5511
|
* @throws {RequiredError}
|
|
5512
5512
|
*/
|
|
@@ -5523,8 +5523,6 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
5523
5523
|
(0, common_1.assertParamExists)('postExtendDisk', 'instanceId', instanceId);
|
|
5524
5524
|
// verify required parameter 'gigabytes' is not null or undefined
|
|
5525
5525
|
(0, common_1.assertParamExists)('postExtendDisk', 'gigabytes', gigabytes);
|
|
5526
|
-
// verify required parameter 'schedule' is not null or undefined
|
|
5527
|
-
(0, common_1.assertParamExists)('postExtendDisk', 'schedule', schedule);
|
|
5528
5526
|
localVarPath = "/tcx/installations/{instance_id}/disk/extend"
|
|
5529
5527
|
.replace("{".concat("instance_id", "}"), encodeURIComponent(String(instanceId)));
|
|
5530
5528
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -5715,6 +5713,88 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
5715
5713
|
});
|
|
5716
5714
|
});
|
|
5717
5715
|
},
|
|
5716
|
+
/**
|
|
5717
|
+
* Restart 3CX Services
|
|
5718
|
+
* @summary Restart 3CX Services
|
|
5719
|
+
* @param {string} instanceId Instance ID
|
|
5720
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
5721
|
+
* @param {*} [options] Override http request option.
|
|
5722
|
+
* @throws {RequiredError}
|
|
5723
|
+
*/
|
|
5724
|
+
postRestartServices: function (instanceId_1, schedule_1) {
|
|
5725
|
+
var args_1 = [];
|
|
5726
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
5727
|
+
args_1[_i - 2] = arguments[_i];
|
|
5728
|
+
}
|
|
5729
|
+
return __awaiter(_this, __spreadArray([instanceId_1, schedule_1], args_1, true), void 0, function (instanceId, schedule, options) {
|
|
5730
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
5731
|
+
if (options === void 0) { options = {}; }
|
|
5732
|
+
return __generator(this, function (_a) {
|
|
5733
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
5734
|
+
(0, common_1.assertParamExists)('postRestartServices', 'instanceId', instanceId);
|
|
5735
|
+
localVarPath = "/tcx/installations/{instance_id}/services/restart"
|
|
5736
|
+
.replace("{".concat("instance_id", "}"), encodeURIComponent(String(instanceId)));
|
|
5737
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5738
|
+
if (configuration) {
|
|
5739
|
+
baseOptions = configuration.baseOptions;
|
|
5740
|
+
}
|
|
5741
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
5742
|
+
localVarHeaderParameter = {};
|
|
5743
|
+
localVarQueryParameter = {};
|
|
5744
|
+
if (schedule !== undefined) {
|
|
5745
|
+
localVarQueryParameter['schedule'] = schedule;
|
|
5746
|
+
}
|
|
5747
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5748
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5749
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5750
|
+
return [2 /*return*/, {
|
|
5751
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5752
|
+
options: localVarRequestOptions,
|
|
5753
|
+
}];
|
|
5754
|
+
});
|
|
5755
|
+
});
|
|
5756
|
+
},
|
|
5757
|
+
/**
|
|
5758
|
+
* Reboot Instance
|
|
5759
|
+
* @summary Reboot Instance
|
|
5760
|
+
* @param {string} instanceId Instance ID
|
|
5761
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
5762
|
+
* @param {*} [options] Override http request option.
|
|
5763
|
+
* @throws {RequiredError}
|
|
5764
|
+
*/
|
|
5765
|
+
postScheduledReboot: function (instanceId_1, schedule_1) {
|
|
5766
|
+
var args_1 = [];
|
|
5767
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
5768
|
+
args_1[_i - 2] = arguments[_i];
|
|
5769
|
+
}
|
|
5770
|
+
return __awaiter(_this, __spreadArray([instanceId_1, schedule_1], args_1, true), void 0, function (instanceId, schedule, options) {
|
|
5771
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
5772
|
+
if (options === void 0) { options = {}; }
|
|
5773
|
+
return __generator(this, function (_a) {
|
|
5774
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
5775
|
+
(0, common_1.assertParamExists)('postScheduledReboot', 'instanceId', instanceId);
|
|
5776
|
+
localVarPath = "/tcx/installations/{instance_id}/reboot/scheduled"
|
|
5777
|
+
.replace("{".concat("instance_id", "}"), encodeURIComponent(String(instanceId)));
|
|
5778
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5779
|
+
if (configuration) {
|
|
5780
|
+
baseOptions = configuration.baseOptions;
|
|
5781
|
+
}
|
|
5782
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
5783
|
+
localVarHeaderParameter = {};
|
|
5784
|
+
localVarQueryParameter = {};
|
|
5785
|
+
if (schedule !== undefined) {
|
|
5786
|
+
localVarQueryParameter['schedule'] = schedule;
|
|
5787
|
+
}
|
|
5788
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5789
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5790
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5791
|
+
return [2 /*return*/, {
|
|
5792
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5793
|
+
options: localVarRequestOptions,
|
|
5794
|
+
}];
|
|
5795
|
+
});
|
|
5796
|
+
});
|
|
5797
|
+
},
|
|
5718
5798
|
/**
|
|
5719
5799
|
* Suspend 3CX Instance
|
|
5720
5800
|
* @summary Suspend 3CX Instance
|
|
@@ -5756,6 +5836,43 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
5756
5836
|
});
|
|
5757
5837
|
});
|
|
5758
5838
|
},
|
|
5839
|
+
/**
|
|
5840
|
+
* Test 3CX Login Credentials
|
|
5841
|
+
* @summary Test 3CX Login Credentials
|
|
5842
|
+
* @param {string} instanceId Instance ID
|
|
5843
|
+
* @param {*} [options] Override http request option.
|
|
5844
|
+
* @throws {RequiredError}
|
|
5845
|
+
*/
|
|
5846
|
+
postTestLoginCredentials: function (instanceId_1) {
|
|
5847
|
+
var args_1 = [];
|
|
5848
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
5849
|
+
args_1[_i - 1] = arguments[_i];
|
|
5850
|
+
}
|
|
5851
|
+
return __awaiter(_this, __spreadArray([instanceId_1], args_1, true), void 0, function (instanceId, options) {
|
|
5852
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
5853
|
+
if (options === void 0) { options = {}; }
|
|
5854
|
+
return __generator(this, function (_a) {
|
|
5855
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
5856
|
+
(0, common_1.assertParamExists)('postTestLoginCredentials', 'instanceId', instanceId);
|
|
5857
|
+
localVarPath = "/tcx/installations/{instance_id}/tests/login"
|
|
5858
|
+
.replace("{".concat("instance_id", "}"), encodeURIComponent(String(instanceId)));
|
|
5859
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5860
|
+
if (configuration) {
|
|
5861
|
+
baseOptions = configuration.baseOptions;
|
|
5862
|
+
}
|
|
5863
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
5864
|
+
localVarHeaderParameter = {};
|
|
5865
|
+
localVarQueryParameter = {};
|
|
5866
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5867
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5868
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5869
|
+
return [2 /*return*/, {
|
|
5870
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5871
|
+
options: localVarRequestOptions,
|
|
5872
|
+
}];
|
|
5873
|
+
});
|
|
5874
|
+
});
|
|
5875
|
+
},
|
|
5759
5876
|
/**
|
|
5760
5877
|
* Unsuspend 3CX Instance
|
|
5761
5878
|
* @summary Unsuspend 3CX Instance
|
|
@@ -6022,7 +6139,7 @@ var Class3CXInstallationsApiFp = function (configuration) {
|
|
|
6022
6139
|
* @summary Extend additional disk on 3CX Instance
|
|
6023
6140
|
* @param {string} instanceId Instance ID
|
|
6024
6141
|
* @param {number} gigabytes Disk Space (GB)
|
|
6025
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
6142
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6026
6143
|
* @param {*} [options] Override http request option.
|
|
6027
6144
|
* @throws {RequiredError}
|
|
6028
6145
|
*/
|
|
@@ -6137,6 +6254,54 @@ var Class3CXInstallationsApiFp = function (configuration) {
|
|
|
6137
6254
|
});
|
|
6138
6255
|
});
|
|
6139
6256
|
},
|
|
6257
|
+
/**
|
|
6258
|
+
* Restart 3CX Services
|
|
6259
|
+
* @summary Restart 3CX Services
|
|
6260
|
+
* @param {string} instanceId Instance ID
|
|
6261
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6262
|
+
* @param {*} [options] Override http request option.
|
|
6263
|
+
* @throws {RequiredError}
|
|
6264
|
+
*/
|
|
6265
|
+
postRestartServices: function (instanceId, schedule, options) {
|
|
6266
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
6267
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
6268
|
+
var _a, _b, _c;
|
|
6269
|
+
return __generator(this, function (_d) {
|
|
6270
|
+
switch (_d.label) {
|
|
6271
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postRestartServices(instanceId, schedule, options)];
|
|
6272
|
+
case 1:
|
|
6273
|
+
localVarAxiosArgs = _d.sent();
|
|
6274
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6275
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXInstallationsApi.postRestartServices']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6276
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
6277
|
+
}
|
|
6278
|
+
});
|
|
6279
|
+
});
|
|
6280
|
+
},
|
|
6281
|
+
/**
|
|
6282
|
+
* Reboot Instance
|
|
6283
|
+
* @summary Reboot Instance
|
|
6284
|
+
* @param {string} instanceId Instance ID
|
|
6285
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6286
|
+
* @param {*} [options] Override http request option.
|
|
6287
|
+
* @throws {RequiredError}
|
|
6288
|
+
*/
|
|
6289
|
+
postScheduledReboot: function (instanceId, schedule, options) {
|
|
6290
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
6291
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
6292
|
+
var _a, _b, _c;
|
|
6293
|
+
return __generator(this, function (_d) {
|
|
6294
|
+
switch (_d.label) {
|
|
6295
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postScheduledReboot(instanceId, schedule, options)];
|
|
6296
|
+
case 1:
|
|
6297
|
+
localVarAxiosArgs = _d.sent();
|
|
6298
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6299
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXInstallationsApi.postScheduledReboot']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6300
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
6301
|
+
}
|
|
6302
|
+
});
|
|
6303
|
+
});
|
|
6304
|
+
},
|
|
6140
6305
|
/**
|
|
6141
6306
|
* Suspend 3CX Instance
|
|
6142
6307
|
* @summary Suspend 3CX Instance
|
|
@@ -6161,6 +6326,29 @@ var Class3CXInstallationsApiFp = function (configuration) {
|
|
|
6161
6326
|
});
|
|
6162
6327
|
});
|
|
6163
6328
|
},
|
|
6329
|
+
/**
|
|
6330
|
+
* Test 3CX Login Credentials
|
|
6331
|
+
* @summary Test 3CX Login Credentials
|
|
6332
|
+
* @param {string} instanceId Instance ID
|
|
6333
|
+
* @param {*} [options] Override http request option.
|
|
6334
|
+
* @throws {RequiredError}
|
|
6335
|
+
*/
|
|
6336
|
+
postTestLoginCredentials: function (instanceId, options) {
|
|
6337
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
6338
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
6339
|
+
var _a, _b, _c;
|
|
6340
|
+
return __generator(this, function (_d) {
|
|
6341
|
+
switch (_d.label) {
|
|
6342
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postTestLoginCredentials(instanceId, options)];
|
|
6343
|
+
case 1:
|
|
6344
|
+
localVarAxiosArgs = _d.sent();
|
|
6345
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6346
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXInstallationsApi.postTestLoginCredentials']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6347
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
6348
|
+
}
|
|
6349
|
+
});
|
|
6350
|
+
});
|
|
6351
|
+
},
|
|
6164
6352
|
/**
|
|
6165
6353
|
* Unsuspend 3CX Instance
|
|
6166
6354
|
* @summary Unsuspend 3CX Instance
|
|
@@ -6303,7 +6491,7 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
|
|
|
6303
6491
|
* @summary Extend additional disk on 3CX Instance
|
|
6304
6492
|
* @param {string} instanceId Instance ID
|
|
6305
6493
|
* @param {number} gigabytes Disk Space (GB)
|
|
6306
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
6494
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6307
6495
|
* @param {*} [options] Override http request option.
|
|
6308
6496
|
* @throws {RequiredError}
|
|
6309
6497
|
*/
|
|
@@ -6353,6 +6541,28 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
|
|
|
6353
6541
|
postResizeInstance: function (instanceId, size, schedule, options) {
|
|
6354
6542
|
return localVarFp.postResizeInstance(instanceId, size, schedule, options).then(function (request) { return request(axios, basePath); });
|
|
6355
6543
|
},
|
|
6544
|
+
/**
|
|
6545
|
+
* Restart 3CX Services
|
|
6546
|
+
* @summary Restart 3CX Services
|
|
6547
|
+
* @param {string} instanceId Instance ID
|
|
6548
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6549
|
+
* @param {*} [options] Override http request option.
|
|
6550
|
+
* @throws {RequiredError}
|
|
6551
|
+
*/
|
|
6552
|
+
postRestartServices: function (instanceId, schedule, options) {
|
|
6553
|
+
return localVarFp.postRestartServices(instanceId, schedule, options).then(function (request) { return request(axios, basePath); });
|
|
6554
|
+
},
|
|
6555
|
+
/**
|
|
6556
|
+
* Reboot Instance
|
|
6557
|
+
* @summary Reboot Instance
|
|
6558
|
+
* @param {string} instanceId Instance ID
|
|
6559
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6560
|
+
* @param {*} [options] Override http request option.
|
|
6561
|
+
* @throws {RequiredError}
|
|
6562
|
+
*/
|
|
6563
|
+
postScheduledReboot: function (instanceId, schedule, options) {
|
|
6564
|
+
return localVarFp.postScheduledReboot(instanceId, schedule, options).then(function (request) { return request(axios, basePath); });
|
|
6565
|
+
},
|
|
6356
6566
|
/**
|
|
6357
6567
|
* Suspend 3CX Instance
|
|
6358
6568
|
* @summary Suspend 3CX Instance
|
|
@@ -6364,6 +6574,16 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
|
|
|
6364
6574
|
postSuspendInstance: function (instanceId, schedule, options) {
|
|
6365
6575
|
return localVarFp.postSuspendInstance(instanceId, schedule, options).then(function (request) { return request(axios, basePath); });
|
|
6366
6576
|
},
|
|
6577
|
+
/**
|
|
6578
|
+
* Test 3CX Login Credentials
|
|
6579
|
+
* @summary Test 3CX Login Credentials
|
|
6580
|
+
* @param {string} instanceId Instance ID
|
|
6581
|
+
* @param {*} [options] Override http request option.
|
|
6582
|
+
* @throws {RequiredError}
|
|
6583
|
+
*/
|
|
6584
|
+
postTestLoginCredentials: function (instanceId, options) {
|
|
6585
|
+
return localVarFp.postTestLoginCredentials(instanceId, options).then(function (request) { return request(axios, basePath); });
|
|
6586
|
+
},
|
|
6367
6587
|
/**
|
|
6368
6588
|
* Unsuspend 3CX Instance
|
|
6369
6589
|
* @summary Unsuspend 3CX Instance
|
|
@@ -6489,7 +6709,7 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
|
|
|
6489
6709
|
* @summary Extend additional disk on 3CX Instance
|
|
6490
6710
|
* @param {string} instanceId Instance ID
|
|
6491
6711
|
* @param {number} gigabytes Disk Space (GB)
|
|
6492
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
6712
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6493
6713
|
* @param {*} [options] Override http request option.
|
|
6494
6714
|
* @throws {RequiredError}
|
|
6495
6715
|
*/
|
|
@@ -6544,6 +6764,30 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
|
|
|
6544
6764
|
var _this = this;
|
|
6545
6765
|
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postResizeInstance(instanceId, size, schedule, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
6546
6766
|
};
|
|
6767
|
+
/**
|
|
6768
|
+
* Restart 3CX Services
|
|
6769
|
+
* @summary Restart 3CX Services
|
|
6770
|
+
* @param {string} instanceId Instance ID
|
|
6771
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6772
|
+
* @param {*} [options] Override http request option.
|
|
6773
|
+
* @throws {RequiredError}
|
|
6774
|
+
*/
|
|
6775
|
+
Class3CXInstallationsApi.prototype.postRestartServices = function (instanceId, schedule, options) {
|
|
6776
|
+
var _this = this;
|
|
6777
|
+
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postRestartServices(instanceId, schedule, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
6778
|
+
};
|
|
6779
|
+
/**
|
|
6780
|
+
* Reboot Instance
|
|
6781
|
+
* @summary Reboot Instance
|
|
6782
|
+
* @param {string} instanceId Instance ID
|
|
6783
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
6784
|
+
* @param {*} [options] Override http request option.
|
|
6785
|
+
* @throws {RequiredError}
|
|
6786
|
+
*/
|
|
6787
|
+
Class3CXInstallationsApi.prototype.postScheduledReboot = function (instanceId, schedule, options) {
|
|
6788
|
+
var _this = this;
|
|
6789
|
+
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postScheduledReboot(instanceId, schedule, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
6790
|
+
};
|
|
6547
6791
|
/**
|
|
6548
6792
|
* Suspend 3CX Instance
|
|
6549
6793
|
* @summary Suspend 3CX Instance
|
|
@@ -6556,6 +6800,17 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
|
|
|
6556
6800
|
var _this = this;
|
|
6557
6801
|
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postSuspendInstance(instanceId, schedule, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
6558
6802
|
};
|
|
6803
|
+
/**
|
|
6804
|
+
* Test 3CX Login Credentials
|
|
6805
|
+
* @summary Test 3CX Login Credentials
|
|
6806
|
+
* @param {string} instanceId Instance ID
|
|
6807
|
+
* @param {*} [options] Override http request option.
|
|
6808
|
+
* @throws {RequiredError}
|
|
6809
|
+
*/
|
|
6810
|
+
Class3CXInstallationsApi.prototype.postTestLoginCredentials = function (instanceId, options) {
|
|
6811
|
+
var _this = this;
|
|
6812
|
+
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postTestLoginCredentials(instanceId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
6813
|
+
};
|
|
6559
6814
|
/**
|
|
6560
6815
|
* Unsuspend 3CX Instance
|
|
6561
6816
|
* @summary Unsuspend 3CX Instance
|
|
@@ -16,12 +16,15 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
16
16
|
|[**postInstallTcxSbc**](#postinstalltcxsbc) | **POST** /tcx/installations/sbcs/{sbc_id}/install | Install 3CX SBC|
|
|
17
17
|
|[**postRebootInstance**](#postrebootinstance) | **POST** /tcx/installations/{instance_id}/reboot | Reboot 3CX Instance|
|
|
18
18
|
|[**postResizeInstance**](#postresizeinstance) | **POST** /tcx/installations/{instance_id}/resize | Resize 3CX Instance|
|
|
19
|
+
|[**postRestartServices**](#postrestartservices) | **POST** /tcx/installations/{instance_id}/services/restart | Restart 3CX Services|
|
|
20
|
+
|[**postScheduledReboot**](#postscheduledreboot) | **POST** /tcx/installations/{instance_id}/reboot/scheduled | Reboot Instance|
|
|
19
21
|
|[**postSuspendInstance**](#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance|
|
|
22
|
+
|[**postTestLoginCredentials**](#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials|
|
|
20
23
|
|[**postUnsuspendInstance**](#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance|
|
|
21
24
|
|[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
|
|
22
25
|
|
|
23
26
|
# **getGetDetails**
|
|
24
|
-
>
|
|
27
|
+
> any getGetDetails()
|
|
25
28
|
|
|
26
29
|
Get 3CX Installation Details
|
|
27
30
|
|
|
@@ -52,7 +55,7 @@ const { status, data } = await apiInstance.getGetDetails(
|
|
|
52
55
|
|
|
53
56
|
### Return type
|
|
54
57
|
|
|
55
|
-
**
|
|
58
|
+
**any**
|
|
56
59
|
|
|
57
60
|
### Authorization
|
|
58
61
|
|
|
@@ -446,7 +449,7 @@ const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
|
446
449
|
|
|
447
450
|
let instanceId: string; //Instance ID (default to undefined)
|
|
448
451
|
let gigabytes: number; //Disk Space (GB) (default to undefined)
|
|
449
|
-
let schedule: string; //Scheduled Task (Date & Time) (default to undefined)
|
|
452
|
+
let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
|
|
450
453
|
|
|
451
454
|
const { status, data } = await apiInstance.postExtendDisk(
|
|
452
455
|
instanceId,
|
|
@@ -461,7 +464,7 @@ const { status, data } = await apiInstance.postExtendDisk(
|
|
|
461
464
|
|------------- | ------------- | ------------- | -------------|
|
|
462
465
|
| **instanceId** | [**string**] | Instance ID | defaults to undefined|
|
|
463
466
|
| **gigabytes** | [**number**] | Disk Space (GB) | defaults to undefined|
|
|
464
|
-
| **schedule** | [**string**] | Scheduled Task (Date & Time) | defaults to undefined|
|
|
467
|
+
| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
|
|
465
468
|
|
|
466
469
|
|
|
467
470
|
### Return type
|
|
@@ -689,6 +692,120 @@ const { status, data } = await apiInstance.postResizeInstance(
|
|
|
689
692
|
| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
|
|
690
693
|
|
|
691
694
|
|
|
695
|
+
### Return type
|
|
696
|
+
|
|
697
|
+
void (empty response body)
|
|
698
|
+
|
|
699
|
+
### Authorization
|
|
700
|
+
|
|
701
|
+
No authorization required
|
|
702
|
+
|
|
703
|
+
### HTTP request headers
|
|
704
|
+
|
|
705
|
+
- **Content-Type**: Not defined
|
|
706
|
+
- **Accept**: Not defined
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
### HTTP response details
|
|
710
|
+
| Status code | Description | Response headers |
|
|
711
|
+
|-------------|-------------|------------------|
|
|
712
|
+
|**200** | No Response | - |
|
|
713
|
+
|**400** | Bad Request | - |
|
|
714
|
+
|**401** | Unauthorised | - |
|
|
715
|
+
|**403** | Access Denied | - |
|
|
716
|
+
|
|
717
|
+
[[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)
|
|
718
|
+
|
|
719
|
+
# **postRestartServices**
|
|
720
|
+
> postRestartServices()
|
|
721
|
+
|
|
722
|
+
Restart 3CX Services
|
|
723
|
+
|
|
724
|
+
### Example
|
|
725
|
+
|
|
726
|
+
```typescript
|
|
727
|
+
import {
|
|
728
|
+
Class3CXInstallationsApi,
|
|
729
|
+
Configuration
|
|
730
|
+
} from 'yellowgrid-api-ts';
|
|
731
|
+
|
|
732
|
+
const configuration = new Configuration();
|
|
733
|
+
const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
734
|
+
|
|
735
|
+
let instanceId: string; //Instance ID (default to undefined)
|
|
736
|
+
let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
|
|
737
|
+
|
|
738
|
+
const { status, data } = await apiInstance.postRestartServices(
|
|
739
|
+
instanceId,
|
|
740
|
+
schedule
|
|
741
|
+
);
|
|
742
|
+
```
|
|
743
|
+
|
|
744
|
+
### Parameters
|
|
745
|
+
|
|
746
|
+
|Name | Type | Description | Notes|
|
|
747
|
+
|------------- | ------------- | ------------- | -------------|
|
|
748
|
+
| **instanceId** | [**string**] | Instance ID | defaults to undefined|
|
|
749
|
+
| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
### Return type
|
|
753
|
+
|
|
754
|
+
void (empty response body)
|
|
755
|
+
|
|
756
|
+
### Authorization
|
|
757
|
+
|
|
758
|
+
No authorization required
|
|
759
|
+
|
|
760
|
+
### HTTP request headers
|
|
761
|
+
|
|
762
|
+
- **Content-Type**: Not defined
|
|
763
|
+
- **Accept**: Not defined
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
### HTTP response details
|
|
767
|
+
| Status code | Description | Response headers |
|
|
768
|
+
|-------------|-------------|------------------|
|
|
769
|
+
|**200** | No Response | - |
|
|
770
|
+
|**400** | Bad Request | - |
|
|
771
|
+
|**401** | Unauthorised | - |
|
|
772
|
+
|**403** | Access Denied | - |
|
|
773
|
+
|
|
774
|
+
[[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)
|
|
775
|
+
|
|
776
|
+
# **postScheduledReboot**
|
|
777
|
+
> postScheduledReboot()
|
|
778
|
+
|
|
779
|
+
Reboot Instance
|
|
780
|
+
|
|
781
|
+
### Example
|
|
782
|
+
|
|
783
|
+
```typescript
|
|
784
|
+
import {
|
|
785
|
+
Class3CXInstallationsApi,
|
|
786
|
+
Configuration
|
|
787
|
+
} from 'yellowgrid-api-ts';
|
|
788
|
+
|
|
789
|
+
const configuration = new Configuration();
|
|
790
|
+
const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
791
|
+
|
|
792
|
+
let instanceId: string; //Instance ID (default to undefined)
|
|
793
|
+
let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
|
|
794
|
+
|
|
795
|
+
const { status, data } = await apiInstance.postScheduledReboot(
|
|
796
|
+
instanceId,
|
|
797
|
+
schedule
|
|
798
|
+
);
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
### Parameters
|
|
802
|
+
|
|
803
|
+
|Name | Type | Description | Notes|
|
|
804
|
+
|------------- | ------------- | ------------- | -------------|
|
|
805
|
+
| **instanceId** | [**string**] | Instance ID | defaults to undefined|
|
|
806
|
+
| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
|
|
807
|
+
|
|
808
|
+
|
|
692
809
|
### Return type
|
|
693
810
|
|
|
694
811
|
void (empty response body)
|
|
@@ -746,6 +863,60 @@ const { status, data } = await apiInstance.postSuspendInstance(
|
|
|
746
863
|
| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
|
|
747
864
|
|
|
748
865
|
|
|
866
|
+
### Return type
|
|
867
|
+
|
|
868
|
+
void (empty response body)
|
|
869
|
+
|
|
870
|
+
### Authorization
|
|
871
|
+
|
|
872
|
+
No authorization required
|
|
873
|
+
|
|
874
|
+
### HTTP request headers
|
|
875
|
+
|
|
876
|
+
- **Content-Type**: Not defined
|
|
877
|
+
- **Accept**: Not defined
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
### HTTP response details
|
|
881
|
+
| Status code | Description | Response headers |
|
|
882
|
+
|-------------|-------------|------------------|
|
|
883
|
+
|**200** | No Response | - |
|
|
884
|
+
|**400** | Bad Request | - |
|
|
885
|
+
|**401** | Unauthorised | - |
|
|
886
|
+
|**403** | Access Denied | - |
|
|
887
|
+
|
|
888
|
+
[[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)
|
|
889
|
+
|
|
890
|
+
# **postTestLoginCredentials**
|
|
891
|
+
> postTestLoginCredentials()
|
|
892
|
+
|
|
893
|
+
Test 3CX Login Credentials
|
|
894
|
+
|
|
895
|
+
### Example
|
|
896
|
+
|
|
897
|
+
```typescript
|
|
898
|
+
import {
|
|
899
|
+
Class3CXInstallationsApi,
|
|
900
|
+
Configuration
|
|
901
|
+
} from 'yellowgrid-api-ts';
|
|
902
|
+
|
|
903
|
+
const configuration = new Configuration();
|
|
904
|
+
const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
905
|
+
|
|
906
|
+
let instanceId: string; //Instance ID (default to undefined)
|
|
907
|
+
|
|
908
|
+
const { status, data } = await apiInstance.postTestLoginCredentials(
|
|
909
|
+
instanceId
|
|
910
|
+
);
|
|
911
|
+
```
|
|
912
|
+
|
|
913
|
+
### Parameters
|
|
914
|
+
|
|
915
|
+
|Name | Type | Description | Notes|
|
|
916
|
+
|------------- | ------------- | ------------- | -------------|
|
|
917
|
+
| **instanceId** | [**string**] | Instance ID | defaults to undefined|
|
|
918
|
+
|
|
919
|
+
|
|
749
920
|
### Return type
|
|
750
921
|
|
|
751
922
|
void (empty response body)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# RemoteStorageDTO
|
|
2
|
+
|
|
3
|
+
Remote Storage
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | AWS ID | [optional] [default to undefined]
|
|
10
|
+
**secret** | **string** | AWS Secret | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | AWS Bucket Name | [optional] [default to undefined]
|
|
12
|
+
**region** | **string** | AWS Region | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { RemoteStorageDTO } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: RemoteStorageDTO = {
|
|
20
|
+
id,
|
|
21
|
+
secret,
|
|
22
|
+
name,
|
|
23
|
+
region,
|
|
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,45 +0,0 @@
|
|
|
1
|
-
# TcxInstallationDetailsModel
|
|
2
|
-
|
|
3
|
-
3CX Installation Details
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
|
|
10
|
-
**instanceId** | **string** | Instance ID | [optional] [default to undefined]
|
|
11
|
-
**project** | **string** | Project ID | [optional] [default to undefined]
|
|
12
|
-
**privateKey** | [**GenericFileModel**](GenericFileModel.md) | | [optional] [default to undefined]
|
|
13
|
-
**rootPassword** | **string** | Root Password | [optional] [default to undefined]
|
|
14
|
-
**ownerExtension** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [optional] [default to undefined]
|
|
15
|
-
**adminEmail** | **string** | Admin Email | [optional] [default to undefined]
|
|
16
|
-
**url** | **string** | Console URL | [optional] [default to undefined]
|
|
17
|
-
**adminUsername** | **string** | Admin Username | [optional] [default to undefined]
|
|
18
|
-
**adminPassword** | **string** | Admin Password | [optional] [default to undefined]
|
|
19
|
-
**ftpHost** | **string** | Config Backup FTP Host | [optional] [default to undefined]
|
|
20
|
-
**ftpUsername** | **string** | Config Backup FTP Username | [optional] [default to undefined]
|
|
21
|
-
**ftpPassword** | **string** | Config Backup FTP Password | [optional] [default to undefined]
|
|
22
|
-
|
|
23
|
-
## Example
|
|
24
|
-
|
|
25
|
-
```typescript
|
|
26
|
-
import { TcxInstallationDetailsModel } from 'yellowgrid-api-ts';
|
|
27
|
-
|
|
28
|
-
const instance: TcxInstallationDetailsModel = {
|
|
29
|
-
ipAddress,
|
|
30
|
-
instanceId,
|
|
31
|
-
project,
|
|
32
|
-
privateKey,
|
|
33
|
-
rootPassword,
|
|
34
|
-
ownerExtension,
|
|
35
|
-
adminEmail,
|
|
36
|
-
url,
|
|
37
|
-
adminUsername,
|
|
38
|
-
adminPassword,
|
|
39
|
-
ftpHost,
|
|
40
|
-
ftpUsername,
|
|
41
|
-
ftpPassword,
|
|
42
|
-
};
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|