yellowgrid-api-ts 3.2.177-dev.0 → 3.2.178-dev.0
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 +2 -1
- package/README.md +4 -1
- package/api.ts +170 -30
- package/dist/api.d.ts +110 -19
- package/dist/api.js +144 -40
- package/docs/Class3CXApi.md +50 -2
- package/docs/ExpiringKeyDTO.md +29 -0
- package/docs/OpayoRedirectDTO.md +29 -0
- package/docs/OrdersApi.md +4 -1
- package/docs/ProductsApi.md +8 -2
- package/docs/ProvisioningApi.md +12 -4
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -4802,6 +4802,40 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
|
|
|
4802
4802
|
* @throws {RequiredError}
|
|
4803
4803
|
*/
|
|
4804
4804
|
getGetTcxExpiringKeys: function () {
|
|
4805
|
+
var args_1 = [];
|
|
4806
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
4807
|
+
args_1[_i] = arguments[_i];
|
|
4808
|
+
}
|
|
4809
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
4810
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
4811
|
+
if (options === void 0) { options = {}; }
|
|
4812
|
+
return __generator(this, function (_a) {
|
|
4813
|
+
localVarPath = "/tcx/admin/keys/expiring";
|
|
4814
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4815
|
+
if (configuration) {
|
|
4816
|
+
baseOptions = configuration.baseOptions;
|
|
4817
|
+
}
|
|
4818
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
4819
|
+
localVarHeaderParameter = {};
|
|
4820
|
+
localVarQueryParameter = {};
|
|
4821
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4822
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4823
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4824
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4825
|
+
return [2 /*return*/, {
|
|
4826
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4827
|
+
options: localVarRequestOptions,
|
|
4828
|
+
}];
|
|
4829
|
+
});
|
|
4830
|
+
});
|
|
4831
|
+
},
|
|
4832
|
+
/**
|
|
4833
|
+
* Get 3CX Expiring Keys
|
|
4834
|
+
* @summary Get 3CX Expiring Keys
|
|
4835
|
+
* @param {*} [options] Override http request option.
|
|
4836
|
+
* @throws {RequiredError}
|
|
4837
|
+
*/
|
|
4838
|
+
getGetTcxExpiringKeysCsv: function () {
|
|
4805
4839
|
var args_1 = [];
|
|
4806
4840
|
for (var _i = 0; _i < arguments.length; _i++) {
|
|
4807
4841
|
args_1[_i] = arguments[_i];
|
|
@@ -4976,6 +5010,28 @@ var Class3CXApiFp = function (configuration) {
|
|
|
4976
5010
|
});
|
|
4977
5011
|
});
|
|
4978
5012
|
},
|
|
5013
|
+
/**
|
|
5014
|
+
* Get 3CX Expiring Keys
|
|
5015
|
+
* @summary Get 3CX Expiring Keys
|
|
5016
|
+
* @param {*} [options] Override http request option.
|
|
5017
|
+
* @throws {RequiredError}
|
|
5018
|
+
*/
|
|
5019
|
+
getGetTcxExpiringKeysCsv: function (options) {
|
|
5020
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5021
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
5022
|
+
var _a, _b, _c;
|
|
5023
|
+
return __generator(this, function (_d) {
|
|
5024
|
+
switch (_d.label) {
|
|
5025
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetTcxExpiringKeysCsv(options)];
|
|
5026
|
+
case 1:
|
|
5027
|
+
localVarAxiosArgs = _d.sent();
|
|
5028
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5029
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetTcxExpiringKeysCsv']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5030
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
5031
|
+
}
|
|
5032
|
+
});
|
|
5033
|
+
});
|
|
5034
|
+
},
|
|
4979
5035
|
/**
|
|
4980
5036
|
* Get 3CX Partners
|
|
4981
5037
|
* @summary Get 3CX Partners
|
|
@@ -5058,6 +5114,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
|
|
|
5058
5114
|
getGetTcxExpiringKeys: function (options) {
|
|
5059
5115
|
return localVarFp.getGetTcxExpiringKeys(options).then(function (request) { return request(axios, basePath); });
|
|
5060
5116
|
},
|
|
5117
|
+
/**
|
|
5118
|
+
* Get 3CX Expiring Keys
|
|
5119
|
+
* @summary Get 3CX Expiring Keys
|
|
5120
|
+
* @param {*} [options] Override http request option.
|
|
5121
|
+
* @throws {RequiredError}
|
|
5122
|
+
*/
|
|
5123
|
+
getGetTcxExpiringKeysCsv: function (options) {
|
|
5124
|
+
return localVarFp.getGetTcxExpiringKeysCsv(options).then(function (request) { return request(axios, basePath); });
|
|
5125
|
+
},
|
|
5061
5126
|
/**
|
|
5062
5127
|
* Get 3CX Partners
|
|
5063
5128
|
* @summary Get 3CX Partners
|
|
@@ -5119,6 +5184,16 @@ var Class3CXApi = /** @class */ (function (_super) {
|
|
|
5119
5184
|
var _this = this;
|
|
5120
5185
|
return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxExpiringKeys(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
5121
5186
|
};
|
|
5187
|
+
/**
|
|
5188
|
+
* Get 3CX Expiring Keys
|
|
5189
|
+
* @summary Get 3CX Expiring Keys
|
|
5190
|
+
* @param {*} [options] Override http request option.
|
|
5191
|
+
* @throws {RequiredError}
|
|
5192
|
+
*/
|
|
5193
|
+
Class3CXApi.prototype.getGetTcxExpiringKeysCsv = function (options) {
|
|
5194
|
+
var _this = this;
|
|
5195
|
+
return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxExpiringKeysCsv(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
5196
|
+
};
|
|
5122
5197
|
/**
|
|
5123
5198
|
* Get 3CX Partners
|
|
5124
5199
|
* @summary Get 3CX Partners
|
|
@@ -13769,20 +13844,23 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
13769
13844
|
* Mark Order As Complete (Admin)
|
|
13770
13845
|
* @summary Mark Order As Complete (Admin)
|
|
13771
13846
|
* @param {number} id Order ID
|
|
13847
|
+
* @param {boolean} complete Complete Status
|
|
13772
13848
|
* @param {*} [options] Override http request option.
|
|
13773
13849
|
* @throws {RequiredError}
|
|
13774
13850
|
*/
|
|
13775
|
-
patchCompleteOrder: function (id_1) {
|
|
13851
|
+
patchCompleteOrder: function (id_1, complete_1) {
|
|
13776
13852
|
var args_1 = [];
|
|
13777
|
-
for (var _i =
|
|
13778
|
-
args_1[_i -
|
|
13853
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
13854
|
+
args_1[_i - 2] = arguments[_i];
|
|
13779
13855
|
}
|
|
13780
|
-
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
13856
|
+
return __awaiter(_this, __spreadArray([id_1, complete_1], args_1, true), void 0, function (id, complete, options) {
|
|
13781
13857
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
13782
13858
|
if (options === void 0) { options = {}; }
|
|
13783
13859
|
return __generator(this, function (_a) {
|
|
13784
13860
|
// verify required parameter 'id' is not null or undefined
|
|
13785
13861
|
(0, common_1.assertParamExists)('patchCompleteOrder', 'id', id);
|
|
13862
|
+
// verify required parameter 'complete' is not null or undefined
|
|
13863
|
+
(0, common_1.assertParamExists)('patchCompleteOrder', 'complete', complete);
|
|
13786
13864
|
localVarPath = "/admin/orders/{id}/complete"
|
|
13787
13865
|
.replace('{id}', encodeURIComponent(String(id)));
|
|
13788
13866
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -13792,6 +13870,9 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
13792
13870
|
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
13793
13871
|
localVarHeaderParameter = {};
|
|
13794
13872
|
localVarQueryParameter = {};
|
|
13873
|
+
if (complete !== undefined) {
|
|
13874
|
+
localVarQueryParameter['complete'] = complete;
|
|
13875
|
+
}
|
|
13795
13876
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
13796
13877
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
13797
13878
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -14916,16 +14997,17 @@ var OrdersApiFp = function (configuration) {
|
|
|
14916
14997
|
* Mark Order As Complete (Admin)
|
|
14917
14998
|
* @summary Mark Order As Complete (Admin)
|
|
14918
14999
|
* @param {number} id Order ID
|
|
15000
|
+
* @param {boolean} complete Complete Status
|
|
14919
15001
|
* @param {*} [options] Override http request option.
|
|
14920
15002
|
* @throws {RequiredError}
|
|
14921
15003
|
*/
|
|
14922
|
-
patchCompleteOrder: function (id, options) {
|
|
15004
|
+
patchCompleteOrder: function (id, complete, options) {
|
|
14923
15005
|
return __awaiter(this, void 0, void 0, function () {
|
|
14924
15006
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
14925
15007
|
var _a, _b, _c;
|
|
14926
15008
|
return __generator(this, function (_d) {
|
|
14927
15009
|
switch (_d.label) {
|
|
14928
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCompleteOrder(id, options)];
|
|
15010
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCompleteOrder(id, complete, options)];
|
|
14929
15011
|
case 1:
|
|
14930
15012
|
localVarAxiosArgs = _d.sent();
|
|
14931
15013
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -15536,11 +15618,12 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
15536
15618
|
* Mark Order As Complete (Admin)
|
|
15537
15619
|
* @summary Mark Order As Complete (Admin)
|
|
15538
15620
|
* @param {number} id Order ID
|
|
15621
|
+
* @param {boolean} complete Complete Status
|
|
15539
15622
|
* @param {*} [options] Override http request option.
|
|
15540
15623
|
* @throws {RequiredError}
|
|
15541
15624
|
*/
|
|
15542
|
-
patchCompleteOrder: function (id, options) {
|
|
15543
|
-
return localVarFp.patchCompleteOrder(id, options).then(function (request) { return request(axios, basePath); });
|
|
15625
|
+
patchCompleteOrder: function (id, complete, options) {
|
|
15626
|
+
return localVarFp.patchCompleteOrder(id, complete, options).then(function (request) { return request(axios, basePath); });
|
|
15544
15627
|
},
|
|
15545
15628
|
/**
|
|
15546
15629
|
* Add Order Note
|
|
@@ -15909,12 +15992,13 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
15909
15992
|
* Mark Order As Complete (Admin)
|
|
15910
15993
|
* @summary Mark Order As Complete (Admin)
|
|
15911
15994
|
* @param {number} id Order ID
|
|
15995
|
+
* @param {boolean} complete Complete Status
|
|
15912
15996
|
* @param {*} [options] Override http request option.
|
|
15913
15997
|
* @throws {RequiredError}
|
|
15914
15998
|
*/
|
|
15915
|
-
OrdersApi.prototype.patchCompleteOrder = function (id, options) {
|
|
15999
|
+
OrdersApi.prototype.patchCompleteOrder = function (id, complete, options) {
|
|
15916
16000
|
var _this = this;
|
|
15917
|
-
return (0, exports.OrdersApiFp)(this.configuration).patchCompleteOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
16001
|
+
return (0, exports.OrdersApiFp)(this.configuration).patchCompleteOrder(id, complete, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
15918
16002
|
};
|
|
15919
16003
|
/**
|
|
15920
16004
|
* Add Order Note
|
|
@@ -16830,15 +16914,16 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
16830
16914
|
* @summary Get Product
|
|
16831
16915
|
* @param {string} sku Product SKU
|
|
16832
16916
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
16917
|
+
* @param {number} [orderId] Order ID
|
|
16833
16918
|
* @param {*} [options] Override http request option.
|
|
16834
16919
|
* @throws {RequiredError}
|
|
16835
16920
|
*/
|
|
16836
|
-
postGetProduct: function (sku_1, postGetProductForCustomerRequest_1) {
|
|
16921
|
+
postGetProduct: function (sku_1, postGetProductForCustomerRequest_1, orderId_1) {
|
|
16837
16922
|
var args_1 = [];
|
|
16838
|
-
for (var _i =
|
|
16839
|
-
args_1[_i -
|
|
16923
|
+
for (var _i = 3; _i < arguments.length; _i++) {
|
|
16924
|
+
args_1[_i - 3] = arguments[_i];
|
|
16840
16925
|
}
|
|
16841
|
-
return __awaiter(_this, __spreadArray([sku_1, postGetProductForCustomerRequest_1], args_1, true), void 0, function (sku, postGetProductForCustomerRequest, options) {
|
|
16926
|
+
return __awaiter(_this, __spreadArray([sku_1, postGetProductForCustomerRequest_1, orderId_1], args_1, true), void 0, function (sku, postGetProductForCustomerRequest, orderId, options) {
|
|
16842
16927
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
16843
16928
|
if (options === void 0) { options = {}; }
|
|
16844
16929
|
return __generator(this, function (_a) {
|
|
@@ -16855,6 +16940,9 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
16855
16940
|
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
16856
16941
|
localVarHeaderParameter = {};
|
|
16857
16942
|
localVarQueryParameter = {};
|
|
16943
|
+
if (orderId !== undefined) {
|
|
16944
|
+
localVarQueryParameter['orderId'] = orderId;
|
|
16945
|
+
}
|
|
16858
16946
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16859
16947
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16860
16948
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -16874,15 +16962,16 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
16874
16962
|
* @param {number} customerId Customer ID
|
|
16875
16963
|
* @param {string} sku Product SKU
|
|
16876
16964
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
16965
|
+
* @param {number} [orderId] Order ID
|
|
16877
16966
|
* @param {*} [options] Override http request option.
|
|
16878
16967
|
* @throws {RequiredError}
|
|
16879
16968
|
*/
|
|
16880
|
-
postGetProductForCustomer: function (customerId_1, sku_1, postGetProductForCustomerRequest_1) {
|
|
16969
|
+
postGetProductForCustomer: function (customerId_1, sku_1, postGetProductForCustomerRequest_1, orderId_1) {
|
|
16881
16970
|
var args_1 = [];
|
|
16882
|
-
for (var _i =
|
|
16883
|
-
args_1[_i -
|
|
16971
|
+
for (var _i = 4; _i < arguments.length; _i++) {
|
|
16972
|
+
args_1[_i - 4] = arguments[_i];
|
|
16884
16973
|
}
|
|
16885
|
-
return __awaiter(_this, __spreadArray([customerId_1, sku_1, postGetProductForCustomerRequest_1], args_1, true), void 0, function (customerId, sku, postGetProductForCustomerRequest, options) {
|
|
16974
|
+
return __awaiter(_this, __spreadArray([customerId_1, sku_1, postGetProductForCustomerRequest_1, orderId_1], args_1, true), void 0, function (customerId, sku, postGetProductForCustomerRequest, orderId, options) {
|
|
16886
16975
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
16887
16976
|
if (options === void 0) { options = {}; }
|
|
16888
16977
|
return __generator(this, function (_a) {
|
|
@@ -16904,6 +16993,9 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
16904
16993
|
if (customerId !== undefined) {
|
|
16905
16994
|
localVarQueryParameter['customerId'] = customerId;
|
|
16906
16995
|
}
|
|
16996
|
+
if (orderId !== undefined) {
|
|
16997
|
+
localVarQueryParameter['orderId'] = orderId;
|
|
16998
|
+
}
|
|
16907
16999
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16908
17000
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16909
17001
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -17114,16 +17206,17 @@ var ProductsApiFp = function (configuration) {
|
|
|
17114
17206
|
* @summary Get Product
|
|
17115
17207
|
* @param {string} sku Product SKU
|
|
17116
17208
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
17209
|
+
* @param {number} [orderId] Order ID
|
|
17117
17210
|
* @param {*} [options] Override http request option.
|
|
17118
17211
|
* @throws {RequiredError}
|
|
17119
17212
|
*/
|
|
17120
|
-
postGetProduct: function (sku, postGetProductForCustomerRequest, options) {
|
|
17213
|
+
postGetProduct: function (sku, postGetProductForCustomerRequest, orderId, options) {
|
|
17121
17214
|
return __awaiter(this, void 0, void 0, function () {
|
|
17122
17215
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
17123
17216
|
var _a, _b, _c;
|
|
17124
17217
|
return __generator(this, function (_d) {
|
|
17125
17218
|
switch (_d.label) {
|
|
17126
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProduct(sku, postGetProductForCustomerRequest, options)];
|
|
17219
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProduct(sku, postGetProductForCustomerRequest, orderId, options)];
|
|
17127
17220
|
case 1:
|
|
17128
17221
|
localVarAxiosArgs = _d.sent();
|
|
17129
17222
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -17139,16 +17232,17 @@ var ProductsApiFp = function (configuration) {
|
|
|
17139
17232
|
* @param {number} customerId Customer ID
|
|
17140
17233
|
* @param {string} sku Product SKU
|
|
17141
17234
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
17235
|
+
* @param {number} [orderId] Order ID
|
|
17142
17236
|
* @param {*} [options] Override http request option.
|
|
17143
17237
|
* @throws {RequiredError}
|
|
17144
17238
|
*/
|
|
17145
|
-
postGetProductForCustomer: function (customerId, sku, postGetProductForCustomerRequest, options) {
|
|
17239
|
+
postGetProductForCustomer: function (customerId, sku, postGetProductForCustomerRequest, orderId, options) {
|
|
17146
17240
|
return __awaiter(this, void 0, void 0, function () {
|
|
17147
17241
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
17148
17242
|
var _a, _b, _c;
|
|
17149
17243
|
return __generator(this, function (_d) {
|
|
17150
17244
|
switch (_d.label) {
|
|
17151
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, options)];
|
|
17245
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, orderId, options)];
|
|
17152
17246
|
case 1:
|
|
17153
17247
|
localVarAxiosArgs = _d.sent();
|
|
17154
17248
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -17251,11 +17345,12 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
17251
17345
|
* @summary Get Product
|
|
17252
17346
|
* @param {string} sku Product SKU
|
|
17253
17347
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
17348
|
+
* @param {number} [orderId] Order ID
|
|
17254
17349
|
* @param {*} [options] Override http request option.
|
|
17255
17350
|
* @throws {RequiredError}
|
|
17256
17351
|
*/
|
|
17257
|
-
postGetProduct: function (sku, postGetProductForCustomerRequest, options) {
|
|
17258
|
-
return localVarFp.postGetProduct(sku, postGetProductForCustomerRequest, options).then(function (request) { return request(axios, basePath); });
|
|
17352
|
+
postGetProduct: function (sku, postGetProductForCustomerRequest, orderId, options) {
|
|
17353
|
+
return localVarFp.postGetProduct(sku, postGetProductForCustomerRequest, orderId, options).then(function (request) { return request(axios, basePath); });
|
|
17259
17354
|
},
|
|
17260
17355
|
/**
|
|
17261
17356
|
* Get Product For Customer
|
|
@@ -17263,11 +17358,12 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
17263
17358
|
* @param {number} customerId Customer ID
|
|
17264
17359
|
* @param {string} sku Product SKU
|
|
17265
17360
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
17361
|
+
* @param {number} [orderId] Order ID
|
|
17266
17362
|
* @param {*} [options] Override http request option.
|
|
17267
17363
|
* @throws {RequiredError}
|
|
17268
17364
|
*/
|
|
17269
|
-
postGetProductForCustomer: function (customerId, sku, postGetProductForCustomerRequest, options) {
|
|
17270
|
-
return localVarFp.postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, options).then(function (request) { return request(axios, basePath); });
|
|
17365
|
+
postGetProductForCustomer: function (customerId, sku, postGetProductForCustomerRequest, orderId, options) {
|
|
17366
|
+
return localVarFp.postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, orderId, options).then(function (request) { return request(axios, basePath); });
|
|
17271
17367
|
},
|
|
17272
17368
|
};
|
|
17273
17369
|
};
|
|
@@ -17372,12 +17468,13 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
17372
17468
|
* @summary Get Product
|
|
17373
17469
|
* @param {string} sku Product SKU
|
|
17374
17470
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
17471
|
+
* @param {number} [orderId] Order ID
|
|
17375
17472
|
* @param {*} [options] Override http request option.
|
|
17376
17473
|
* @throws {RequiredError}
|
|
17377
17474
|
*/
|
|
17378
|
-
ProductsApi.prototype.postGetProduct = function (sku, postGetProductForCustomerRequest, options) {
|
|
17475
|
+
ProductsApi.prototype.postGetProduct = function (sku, postGetProductForCustomerRequest, orderId, options) {
|
|
17379
17476
|
var _this = this;
|
|
17380
|
-
return (0, exports.ProductsApiFp)(this.configuration).postGetProduct(sku, postGetProductForCustomerRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
17477
|
+
return (0, exports.ProductsApiFp)(this.configuration).postGetProduct(sku, postGetProductForCustomerRequest, orderId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
17381
17478
|
};
|
|
17382
17479
|
/**
|
|
17383
17480
|
* Get Product For Customer
|
|
@@ -17385,12 +17482,13 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
17385
17482
|
* @param {number} customerId Customer ID
|
|
17386
17483
|
* @param {string} sku Product SKU
|
|
17387
17484
|
* @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
|
|
17485
|
+
* @param {number} [orderId] Order ID
|
|
17388
17486
|
* @param {*} [options] Override http request option.
|
|
17389
17487
|
* @throws {RequiredError}
|
|
17390
17488
|
*/
|
|
17391
|
-
ProductsApi.prototype.postGetProductForCustomer = function (customerId, sku, postGetProductForCustomerRequest, options) {
|
|
17489
|
+
ProductsApi.prototype.postGetProductForCustomer = function (customerId, sku, postGetProductForCustomerRequest, orderId, options) {
|
|
17392
17490
|
var _this = this;
|
|
17393
|
-
return (0, exports.ProductsApiFp)(this.configuration).postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
17491
|
+
return (0, exports.ProductsApiFp)(this.configuration).postGetProductForCustomer(customerId, sku, postGetProductForCustomerRequest, orderId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
17394
17492
|
};
|
|
17395
17493
|
return ProductsApi;
|
|
17396
17494
|
}(base_1.BaseAPI));
|
|
@@ -18131,15 +18229,16 @@ var ProvisioningApiAxiosParamCreator = function (configuration) {
|
|
|
18131
18229
|
},
|
|
18132
18230
|
/**
|
|
18133
18231
|
* Create a MAC address in FDPS
|
|
18232
|
+
* @param {MacAddressDTO} [macAddressDTO] Mac Address
|
|
18134
18233
|
* @param {*} [options] Override http request option.
|
|
18135
18234
|
* @throws {RequiredError}
|
|
18136
18235
|
*/
|
|
18137
|
-
postCreateMac: function () {
|
|
18236
|
+
postCreateMac: function (macAddressDTO_1) {
|
|
18138
18237
|
var args_1 = [];
|
|
18139
|
-
for (var _i =
|
|
18140
|
-
args_1[_i] = arguments[_i];
|
|
18238
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
18239
|
+
args_1[_i - 1] = arguments[_i];
|
|
18141
18240
|
}
|
|
18142
|
-
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
18241
|
+
return __awaiter(_this, __spreadArray([macAddressDTO_1], args_1, true), void 0, function (macAddressDTO, options) {
|
|
18143
18242
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
18144
18243
|
if (options === void 0) { options = {}; }
|
|
18145
18244
|
return __generator(this, function (_a) {
|
|
@@ -18151,10 +18250,12 @@ var ProvisioningApiAxiosParamCreator = function (configuration) {
|
|
|
18151
18250
|
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
18152
18251
|
localVarHeaderParameter = {};
|
|
18153
18252
|
localVarQueryParameter = {};
|
|
18253
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
18154
18254
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
18155
18255
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
18156
18256
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18157
18257
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18258
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(macAddressDTO, localVarRequestOptions, configuration);
|
|
18158
18259
|
return [2 /*return*/, {
|
|
18159
18260
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
18160
18261
|
options: localVarRequestOptions,
|
|
@@ -18381,16 +18482,17 @@ var ProvisioningApiFp = function (configuration) {
|
|
|
18381
18482
|
},
|
|
18382
18483
|
/**
|
|
18383
18484
|
* Create a MAC address in FDPS
|
|
18485
|
+
* @param {MacAddressDTO} [macAddressDTO] Mac Address
|
|
18384
18486
|
* @param {*} [options] Override http request option.
|
|
18385
18487
|
* @throws {RequiredError}
|
|
18386
18488
|
*/
|
|
18387
|
-
postCreateMac: function (options) {
|
|
18489
|
+
postCreateMac: function (macAddressDTO, options) {
|
|
18388
18490
|
return __awaiter(this, void 0, void 0, function () {
|
|
18389
18491
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
18390
18492
|
var _a, _b, _c;
|
|
18391
18493
|
return __generator(this, function (_d) {
|
|
18392
18494
|
switch (_d.label) {
|
|
18393
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postCreateMac(options)];
|
|
18495
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postCreateMac(macAddressDTO, options)];
|
|
18394
18496
|
case 1:
|
|
18395
18497
|
localVarAxiosArgs = _d.sent();
|
|
18396
18498
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -18502,11 +18604,12 @@ var ProvisioningApiFactory = function (configuration, basePath, axios) {
|
|
|
18502
18604
|
},
|
|
18503
18605
|
/**
|
|
18504
18606
|
* Create a MAC address in FDPS
|
|
18607
|
+
* @param {MacAddressDTO} [macAddressDTO] Mac Address
|
|
18505
18608
|
* @param {*} [options] Override http request option.
|
|
18506
18609
|
* @throws {RequiredError}
|
|
18507
18610
|
*/
|
|
18508
|
-
postCreateMac: function (options) {
|
|
18509
|
-
return localVarFp.postCreateMac(options).then(function (request) { return request(axios, basePath); });
|
|
18611
|
+
postCreateMac: function (macAddressDTO, options) {
|
|
18612
|
+
return localVarFp.postCreateMac(macAddressDTO, options).then(function (request) { return request(axios, basePath); });
|
|
18510
18613
|
},
|
|
18511
18614
|
};
|
|
18512
18615
|
};
|
|
@@ -18621,12 +18724,13 @@ var ProvisioningApi = /** @class */ (function (_super) {
|
|
|
18621
18724
|
};
|
|
18622
18725
|
/**
|
|
18623
18726
|
* Create a MAC address in FDPS
|
|
18727
|
+
* @param {MacAddressDTO} [macAddressDTO] Mac Address
|
|
18624
18728
|
* @param {*} [options] Override http request option.
|
|
18625
18729
|
* @throws {RequiredError}
|
|
18626
18730
|
*/
|
|
18627
|
-
ProvisioningApi.prototype.postCreateMac = function (options) {
|
|
18731
|
+
ProvisioningApi.prototype.postCreateMac = function (macAddressDTO, options) {
|
|
18628
18732
|
var _this = this;
|
|
18629
|
-
return (0, exports.ProvisioningApiFp)(this.configuration).postCreateMac(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
18733
|
+
return (0, exports.ProvisioningApiFp)(this.configuration).postCreateMac(macAddressDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
18630
18734
|
};
|
|
18631
18735
|
return ProvisioningApi;
|
|
18632
18736
|
}(base_1.BaseAPI));
|
package/docs/Class3CXApi.md
CHANGED
|
@@ -6,7 +6,8 @@ All URIs are relative to *https://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
|
|
8
8
|
|[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
|
|
9
|
-
|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring
|
|
9
|
+
|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
|
|
10
|
+
|[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
|
|
10
11
|
|[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
|
|
11
12
|
|[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
|
|
12
13
|
|
|
@@ -112,7 +113,7 @@ No authorization required
|
|
|
112
113
|
[[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)
|
|
113
114
|
|
|
114
115
|
# **getGetTcxExpiringKeys**
|
|
115
|
-
>
|
|
116
|
+
> Array<ExpiringKeyDTO> getGetTcxExpiringKeys()
|
|
116
117
|
|
|
117
118
|
Get 3CX Expiring Keys
|
|
118
119
|
|
|
@@ -134,6 +135,53 @@ const { status, data } = await apiInstance.getGetTcxExpiringKeys();
|
|
|
134
135
|
This endpoint does not have any parameters.
|
|
135
136
|
|
|
136
137
|
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
**Array<ExpiringKeyDTO>**
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
No authorization required
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: Not defined
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
### HTTP response details
|
|
153
|
+
| Status code | Description | Response headers |
|
|
154
|
+
|-------------|-------------|------------------|
|
|
155
|
+
|**200** | 3CX Expiring Key | - |
|
|
156
|
+
|**400** | Bad Request | - |
|
|
157
|
+
|**401** | Unauthorised | - |
|
|
158
|
+
|**403** | Access Denied | - |
|
|
159
|
+
|
|
160
|
+
[[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)
|
|
161
|
+
|
|
162
|
+
# **getGetTcxExpiringKeysCsv**
|
|
163
|
+
> string getGetTcxExpiringKeysCsv()
|
|
164
|
+
|
|
165
|
+
Get 3CX Expiring Keys
|
|
166
|
+
|
|
167
|
+
### Example
|
|
168
|
+
|
|
169
|
+
```typescript
|
|
170
|
+
import {
|
|
171
|
+
Class3CXApi,
|
|
172
|
+
Configuration
|
|
173
|
+
} from 'yellowgrid-api-ts';
|
|
174
|
+
|
|
175
|
+
const configuration = new Configuration();
|
|
176
|
+
const apiInstance = new Class3CXApi(configuration);
|
|
177
|
+
|
|
178
|
+
const { status, data } = await apiInstance.getGetTcxExpiringKeysCsv();
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Parameters
|
|
182
|
+
This endpoint does not have any parameters.
|
|
183
|
+
|
|
184
|
+
|
|
137
185
|
### Return type
|
|
138
186
|
|
|
139
187
|
**string**
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# ExpiringKeyDTO
|
|
2
|
+
|
|
3
|
+
3CX Expiring Key
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**expiryDate** | **string** | Date Time | [optional] [default to undefined]
|
|
10
|
+
**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
|
|
11
|
+
**edition** | **string** | Edition | [optional] [default to undefined]
|
|
12
|
+
**type** | **string** | Type | [optional] [default to undefined]
|
|
13
|
+
**partner** | [**PartnerDTO**](PartnerDTO.md) | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { ExpiringKeyDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: ExpiringKeyDTO = {
|
|
21
|
+
expiryDate,
|
|
22
|
+
licenceKey,
|
|
23
|
+
edition,
|
|
24
|
+
type,
|
|
25
|
+
partner,
|
|
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,29 @@
|
|
|
1
|
+
# OpayoRedirectDTO
|
|
2
|
+
|
|
3
|
+
Opayo Redirect
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**acsUrl** | **string** | acsUrl | [optional] [default to undefined]
|
|
10
|
+
**paReq** | **string** | paReq | [optional] [default to undefined]
|
|
11
|
+
**transactionId** | **string** | Transaction ID | [optional] [default to undefined]
|
|
12
|
+
**dsTranId** | **string** | dsTranId | [optional] [default to undefined]
|
|
13
|
+
**cReq** | **string** | cReq | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { OpayoRedirectDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: OpayoRedirectDTO = {
|
|
21
|
+
acsUrl,
|
|
22
|
+
paReq,
|
|
23
|
+
transactionId,
|
|
24
|
+
dsTranId,
|
|
25
|
+
cReq,
|
|
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)
|
package/docs/OrdersApi.md
CHANGED
|
@@ -683,9 +683,11 @@ const configuration = new Configuration();
|
|
|
683
683
|
const apiInstance = new OrdersApi(configuration);
|
|
684
684
|
|
|
685
685
|
let id: number; //Order ID (default to undefined)
|
|
686
|
+
let complete: boolean; //Complete Status (default to undefined)
|
|
686
687
|
|
|
687
688
|
const { status, data } = await apiInstance.patchCompleteOrder(
|
|
688
|
-
id
|
|
689
|
+
id,
|
|
690
|
+
complete
|
|
689
691
|
);
|
|
690
692
|
```
|
|
691
693
|
|
|
@@ -694,6 +696,7 @@ const { status, data } = await apiInstance.patchCompleteOrder(
|
|
|
694
696
|
|Name | Type | Description | Notes|
|
|
695
697
|
|------------- | ------------- | ------------- | -------------|
|
|
696
698
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
699
|
+
| **complete** | [**boolean**] | Complete Status | defaults to undefined|
|
|
697
700
|
|
|
698
701
|
|
|
699
702
|
### Return type
|
package/docs/ProductsApi.md
CHANGED
|
@@ -440,10 +440,12 @@ const apiInstance = new ProductsApi(configuration);
|
|
|
440
440
|
|
|
441
441
|
let sku: string; //Product SKU (default to undefined)
|
|
442
442
|
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
443
|
+
let orderId: number; //Order ID (optional) (default to undefined)
|
|
443
444
|
|
|
444
445
|
const { status, data } = await apiInstance.postGetProduct(
|
|
445
446
|
sku,
|
|
446
|
-
postGetProductForCustomerRequest
|
|
447
|
+
postGetProductForCustomerRequest,
|
|
448
|
+
orderId
|
|
447
449
|
);
|
|
448
450
|
```
|
|
449
451
|
|
|
@@ -453,6 +455,7 @@ const { status, data } = await apiInstance.postGetProduct(
|
|
|
453
455
|
|------------- | ------------- | ------------- | -------------|
|
|
454
456
|
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
455
457
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
458
|
+
| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
|
|
456
459
|
|
|
457
460
|
|
|
458
461
|
### Return type
|
|
@@ -499,11 +502,13 @@ const apiInstance = new ProductsApi(configuration);
|
|
|
499
502
|
let customerId: number; //Customer ID (default to undefined)
|
|
500
503
|
let sku: string; //Product SKU (default to undefined)
|
|
501
504
|
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
505
|
+
let orderId: number; //Order ID (optional) (default to undefined)
|
|
502
506
|
|
|
503
507
|
const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
504
508
|
customerId,
|
|
505
509
|
sku,
|
|
506
|
-
postGetProductForCustomerRequest
|
|
510
|
+
postGetProductForCustomerRequest,
|
|
511
|
+
orderId
|
|
507
512
|
);
|
|
508
513
|
```
|
|
509
514
|
|
|
@@ -514,6 +519,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
|
514
519
|
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
515
520
|
| **customerId** | [**number**] | Customer ID | defaults to undefined|
|
|
516
521
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
522
|
+
| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
|
|
517
523
|
|
|
518
524
|
|
|
519
525
|
### Return type
|