yellowgrid-api-ts 3.2.6-dev.0 → 3.2.8-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/README.md +4 -3
- package/api.ts +106 -41
- package/dist/api.d.ts +73 -41
- package/dist/api.js +98 -24
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminOrderRequestDTO.md +2 -0
- package/docs/NumberPortDTO.md +1 -1
- package/docs/NumberPortingApi.md +8 -8
- package/docs/OAuth20Api.md +3 -3
- package/docs/ProductsApi.md +48 -0
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -740,7 +740,7 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
740
740
|
},
|
|
741
741
|
/**
|
|
742
742
|
* Create new customer account
|
|
743
|
-
* @summary Create new customer account
|
|
743
|
+
* @summary Create a new customer account
|
|
744
744
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
745
745
|
* @param {*} [options] Override http request option.
|
|
746
746
|
* @throws {RequiredError}
|
|
@@ -1291,7 +1291,7 @@ var AccountsApiFp = function (configuration) {
|
|
|
1291
1291
|
},
|
|
1292
1292
|
/**
|
|
1293
1293
|
* Create new customer account
|
|
1294
|
-
* @summary Create new customer account
|
|
1294
|
+
* @summary Create a new customer account
|
|
1295
1295
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
1296
1296
|
* @param {*} [options] Override http request option.
|
|
1297
1297
|
* @throws {RequiredError}
|
|
@@ -1583,7 +1583,7 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
1583
1583
|
},
|
|
1584
1584
|
/**
|
|
1585
1585
|
* Create new customer account
|
|
1586
|
-
* @summary Create new customer account
|
|
1586
|
+
* @summary Create a new customer account
|
|
1587
1587
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
1588
1588
|
* @param {*} [options] Override http request option.
|
|
1589
1589
|
* @throws {RequiredError}
|
|
@@ -1798,7 +1798,7 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
1798
1798
|
};
|
|
1799
1799
|
/**
|
|
1800
1800
|
* Create new customer account
|
|
1801
|
-
* @summary Create new customer account
|
|
1801
|
+
* @summary Create a new customer account
|
|
1802
1802
|
* @param {AccountRequestModel} [accountRequestModel] New account request
|
|
1803
1803
|
* @param {*} [options] Override http request option.
|
|
1804
1804
|
* @throws {RequiredError}
|
|
@@ -7515,7 +7515,7 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
7515
7515
|
* @param {string | null} [city] City
|
|
7516
7516
|
* @param {string | null} [postCode] Post Code
|
|
7517
7517
|
* @param {number | null} [trunkId] Trunk ID
|
|
7518
|
-
* @param {
|
|
7518
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
7519
7519
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
7520
7520
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
7521
7521
|
* @param {string | null} [comment] Comment
|
|
@@ -7599,7 +7599,7 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
7599
7599
|
* @param {string | null} [city] City
|
|
7600
7600
|
* @param {string | null} [postCode] Post Code
|
|
7601
7601
|
* @param {number | null} [trunkId] Trunk ID
|
|
7602
|
-
* @param {
|
|
7602
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
7603
7603
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
7604
7604
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
7605
7605
|
* @param {string | null} [comment] Comment
|
|
@@ -7686,7 +7686,7 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
7686
7686
|
* @param {string | null} [city] City
|
|
7687
7687
|
* @param {string | null} [postCode] Post Code
|
|
7688
7688
|
* @param {number | null} [trunkId] Trunk ID
|
|
7689
|
-
* @param {
|
|
7689
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
7690
7690
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
7691
7691
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
7692
7692
|
* @param {string | null} [comment] Comment
|
|
@@ -7773,7 +7773,7 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
|
|
|
7773
7773
|
* @param {string | null} [city] City
|
|
7774
7774
|
* @param {string | null} [postCode] Post Code
|
|
7775
7775
|
* @param {number | null} [trunkId] Trunk ID
|
|
7776
|
-
* @param {
|
|
7776
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
7777
7777
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
7778
7778
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
7779
7779
|
* @param {string | null} [comment] Comment
|
|
@@ -7998,7 +7998,7 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
7998
7998
|
* @param {string | null} [city] City
|
|
7999
7999
|
* @param {string | null} [postCode] Post Code
|
|
8000
8000
|
* @param {number | null} [trunkId] Trunk ID
|
|
8001
|
-
* @param {
|
|
8001
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8002
8002
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8003
8003
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8004
8004
|
* @param {string | null} [comment] Comment
|
|
@@ -8032,7 +8032,7 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
8032
8032
|
* @param {string | null} [city] City
|
|
8033
8033
|
* @param {string | null} [postCode] Post Code
|
|
8034
8034
|
* @param {number | null} [trunkId] Trunk ID
|
|
8035
|
-
* @param {
|
|
8035
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8036
8036
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8037
8037
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8038
8038
|
* @param {string | null} [comment] Comment
|
|
@@ -8066,7 +8066,7 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
8066
8066
|
* @param {string | null} [city] City
|
|
8067
8067
|
* @param {string | null} [postCode] Post Code
|
|
8068
8068
|
* @param {number | null} [trunkId] Trunk ID
|
|
8069
|
-
* @param {
|
|
8069
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8070
8070
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8071
8071
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8072
8072
|
* @param {string | null} [comment] Comment
|
|
@@ -8100,7 +8100,7 @@ var NumberPortingApiFp = function (configuration) {
|
|
|
8100
8100
|
* @param {string | null} [city] City
|
|
8101
8101
|
* @param {string | null} [postCode] Post Code
|
|
8102
8102
|
* @param {number | null} [trunkId] Trunk ID
|
|
8103
|
-
* @param {
|
|
8103
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8104
8104
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8105
8105
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8106
8106
|
* @param {string | null} [comment] Comment
|
|
@@ -8195,7 +8195,7 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8195
8195
|
* @param {string | null} [city] City
|
|
8196
8196
|
* @param {string | null} [postCode] Post Code
|
|
8197
8197
|
* @param {number | null} [trunkId] Trunk ID
|
|
8198
|
-
* @param {
|
|
8198
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8199
8199
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8200
8200
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8201
8201
|
* @param {string | null} [comment] Comment
|
|
@@ -8216,7 +8216,7 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8216
8216
|
* @param {string | null} [city] City
|
|
8217
8217
|
* @param {string | null} [postCode] Post Code
|
|
8218
8218
|
* @param {number | null} [trunkId] Trunk ID
|
|
8219
|
-
* @param {
|
|
8219
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8220
8220
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8221
8221
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8222
8222
|
* @param {string | null} [comment] Comment
|
|
@@ -8237,7 +8237,7 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8237
8237
|
* @param {string | null} [city] City
|
|
8238
8238
|
* @param {string | null} [postCode] Post Code
|
|
8239
8239
|
* @param {number | null} [trunkId] Trunk ID
|
|
8240
|
-
* @param {
|
|
8240
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8241
8241
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8242
8242
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8243
8243
|
* @param {string | null} [comment] Comment
|
|
@@ -8258,7 +8258,7 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
|
|
|
8258
8258
|
* @param {string | null} [city] City
|
|
8259
8259
|
* @param {string | null} [postCode] Post Code
|
|
8260
8260
|
* @param {number | null} [trunkId] Trunk ID
|
|
8261
|
-
* @param {
|
|
8261
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8262
8262
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8263
8263
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8264
8264
|
* @param {string | null} [comment] Comment
|
|
@@ -8347,7 +8347,7 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
8347
8347
|
* @param {string | null} [city] City
|
|
8348
8348
|
* @param {string | null} [postCode] Post Code
|
|
8349
8349
|
* @param {number | null} [trunkId] Trunk ID
|
|
8350
|
-
* @param {
|
|
8350
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8351
8351
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8352
8352
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8353
8353
|
* @param {string | null} [comment] Comment
|
|
@@ -8369,7 +8369,7 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
8369
8369
|
* @param {string | null} [city] City
|
|
8370
8370
|
* @param {string | null} [postCode] Post Code
|
|
8371
8371
|
* @param {number | null} [trunkId] Trunk ID
|
|
8372
|
-
* @param {
|
|
8372
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8373
8373
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8374
8374
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8375
8375
|
* @param {string | null} [comment] Comment
|
|
@@ -8391,7 +8391,7 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
8391
8391
|
* @param {string | null} [city] City
|
|
8392
8392
|
* @param {string | null} [postCode] Post Code
|
|
8393
8393
|
* @param {number | null} [trunkId] Trunk ID
|
|
8394
|
-
* @param {
|
|
8394
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8395
8395
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8396
8396
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8397
8397
|
* @param {string | null} [comment] Comment
|
|
@@ -8413,7 +8413,7 @@ var NumberPortingApi = /** @class */ (function (_super) {
|
|
|
8413
8413
|
* @param {string | null} [city] City
|
|
8414
8414
|
* @param {string | null} [postCode] Post Code
|
|
8415
8415
|
* @param {number | null} [trunkId] Trunk ID
|
|
8416
|
-
* @param {
|
|
8416
|
+
* @param {string | null} [tenantId] Starter Bundle ID
|
|
8417
8417
|
* @param {string | null} [requestedPortDate] Requested Port Date
|
|
8418
8418
|
* @param {boolean | null} [asap] Port Date ASAP
|
|
8419
8419
|
* @param {string | null} [comment] Comment
|
|
@@ -9080,8 +9080,8 @@ exports.PostAccessTokenScopeEnum = {
|
|
|
9080
9080
|
TcxWizard: 'tcx_wizard',
|
|
9081
9081
|
AccountsRead: 'accounts.read',
|
|
9082
9082
|
AccountsWrite: 'accounts.write',
|
|
9083
|
-
|
|
9084
|
-
|
|
9083
|
+
NumberPortingRead: 'number_porting.read',
|
|
9084
|
+
NumberPortingWrite: 'number_porting.write',
|
|
9085
9085
|
PricingRead: 'pricing.read',
|
|
9086
9086
|
OrdersRead: 'orders.read',
|
|
9087
9087
|
OrdersWrite: 'orders.write',
|
|
@@ -9112,8 +9112,8 @@ exports.PostAuthoriseScopeEnum = {
|
|
|
9112
9112
|
TcxWizard: 'tcx_wizard',
|
|
9113
9113
|
AccountsRead: 'accounts.read',
|
|
9114
9114
|
AccountsWrite: 'accounts.write',
|
|
9115
|
-
|
|
9116
|
-
|
|
9115
|
+
NumberPortingRead: 'number_porting.read',
|
|
9116
|
+
NumberPortingWrite: 'number_porting.write',
|
|
9117
9117
|
PricingRead: 'pricing.read',
|
|
9118
9118
|
OrdersRead: 'orders.read',
|
|
9119
9119
|
OrdersWrite: 'orders.write',
|
|
@@ -10288,6 +10288,39 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
10288
10288
|
});
|
|
10289
10289
|
});
|
|
10290
10290
|
},
|
|
10291
|
+
/**
|
|
10292
|
+
* Get Customer Price Lists
|
|
10293
|
+
* @summary Get Customer Price Lists
|
|
10294
|
+
* @param {*} [options] Override http request option.
|
|
10295
|
+
* @throws {RequiredError}
|
|
10296
|
+
*/
|
|
10297
|
+
getGetCustomerPriceLists: function () {
|
|
10298
|
+
var args_1 = [];
|
|
10299
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
10300
|
+
args_1[_i] = arguments[_i];
|
|
10301
|
+
}
|
|
10302
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
10303
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10304
|
+
if (options === void 0) { options = {}; }
|
|
10305
|
+
return __generator(this, function (_a) {
|
|
10306
|
+
localVarPath = "/products/prices/lists";
|
|
10307
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10308
|
+
if (configuration) {
|
|
10309
|
+
baseOptions = configuration.baseOptions;
|
|
10310
|
+
}
|
|
10311
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
10312
|
+
localVarHeaderParameter = {};
|
|
10313
|
+
localVarQueryParameter = {};
|
|
10314
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10315
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10316
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10317
|
+
return [2 /*return*/, {
|
|
10318
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10319
|
+
options: localVarRequestOptions,
|
|
10320
|
+
}];
|
|
10321
|
+
});
|
|
10322
|
+
});
|
|
10323
|
+
},
|
|
10291
10324
|
/**
|
|
10292
10325
|
* Get Current Stock & Pricing
|
|
10293
10326
|
* @summary Get Current Stock & Pricing
|
|
@@ -10593,6 +10626,28 @@ var ProductsApiFp = function (configuration) {
|
|
|
10593
10626
|
});
|
|
10594
10627
|
});
|
|
10595
10628
|
},
|
|
10629
|
+
/**
|
|
10630
|
+
* Get Customer Price Lists
|
|
10631
|
+
* @summary Get Customer Price Lists
|
|
10632
|
+
* @param {*} [options] Override http request option.
|
|
10633
|
+
* @throws {RequiredError}
|
|
10634
|
+
*/
|
|
10635
|
+
getGetCustomerPriceLists: function (options) {
|
|
10636
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
10637
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
10638
|
+
var _a, _b, _c;
|
|
10639
|
+
return __generator(this, function (_d) {
|
|
10640
|
+
switch (_d.label) {
|
|
10641
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCustomerPriceLists(options)];
|
|
10642
|
+
case 1:
|
|
10643
|
+
localVarAxiosArgs = _d.sent();
|
|
10644
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
10645
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.getGetCustomerPriceLists']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
10646
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
10647
|
+
}
|
|
10648
|
+
});
|
|
10649
|
+
});
|
|
10650
|
+
},
|
|
10596
10651
|
/**
|
|
10597
10652
|
* Get Current Stock & Pricing
|
|
10598
10653
|
* @summary Get Current Stock & Pricing
|
|
@@ -10775,6 +10830,15 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
10775
10830
|
getGetAttributeSets: function (options) {
|
|
10776
10831
|
return localVarFp.getGetAttributeSets(options).then(function (request) { return request(axios, basePath); });
|
|
10777
10832
|
},
|
|
10833
|
+
/**
|
|
10834
|
+
* Get Customer Price Lists
|
|
10835
|
+
* @summary Get Customer Price Lists
|
|
10836
|
+
* @param {*} [options] Override http request option.
|
|
10837
|
+
* @throws {RequiredError}
|
|
10838
|
+
*/
|
|
10839
|
+
getGetCustomerPriceLists: function (options) {
|
|
10840
|
+
return localVarFp.getGetCustomerPriceLists(options).then(function (request) { return request(axios, basePath); });
|
|
10841
|
+
},
|
|
10778
10842
|
/**
|
|
10779
10843
|
* Get Current Stock & Pricing
|
|
10780
10844
|
* @summary Get Current Stock & Pricing
|
|
@@ -10869,6 +10933,16 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
10869
10933
|
var _this = this;
|
|
10870
10934
|
return (0, exports.ProductsApiFp)(this.configuration).getGetAttributeSets(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
10871
10935
|
};
|
|
10936
|
+
/**
|
|
10937
|
+
* Get Customer Price Lists
|
|
10938
|
+
* @summary Get Customer Price Lists
|
|
10939
|
+
* @param {*} [options] Override http request option.
|
|
10940
|
+
* @throws {RequiredError}
|
|
10941
|
+
*/
|
|
10942
|
+
ProductsApi.prototype.getGetCustomerPriceLists = function (options) {
|
|
10943
|
+
var _this = this;
|
|
10944
|
+
return (0, exports.ProductsApiFp)(this.configuration).getGetCustomerPriceLists(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
10945
|
+
};
|
|
10872
10946
|
/**
|
|
10873
10947
|
* Get Current Stock & Pricing
|
|
10874
10948
|
* @summary Get Current Stock & Pricing
|
package/docs/AccountsApi.md
CHANGED
|
@@ -16,7 +16,7 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
16
16
|
|[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
|
|
17
17
|
|[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
|
|
18
18
|
|[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
|
|
19
|
-
|[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create new customer account|
|
|
19
|
+
|[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
|
|
20
20
|
|[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
|
|
21
21
|
|[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
|
|
22
22
|
|[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**ignoreCreditLimit** | **boolean** | Ignore Customer Credit Limit | [optional] [default to false]
|
|
20
20
|
**includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
|
|
21
21
|
**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
|
|
22
|
+
**sendOrderEmail** | **boolean** | Send Order Email | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -39,6 +40,7 @@ const instance: AdminOrderRequestDTO = {
|
|
|
39
40
|
ignoreCreditLimit,
|
|
40
41
|
includeNfrPromos,
|
|
41
42
|
carriageCharge,
|
|
43
|
+
sendOrderEmail,
|
|
42
44
|
};
|
|
43
45
|
```
|
|
44
46
|
|
package/docs/NumberPortDTO.md
CHANGED
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**city** | **string** | City | [optional] [default to undefined]
|
|
13
13
|
**postCode** | **string** | Post Code | [optional] [default to undefined]
|
|
14
14
|
**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
|
|
15
|
-
**tenantId** | **
|
|
15
|
+
**tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
|
|
16
16
|
**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
|
|
17
17
|
**asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
|
|
18
18
|
**comment** | **string** | Comment | [optional] [default to undefined]
|
package/docs/NumberPortingApi.md
CHANGED
|
@@ -312,7 +312,7 @@ let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
|
312
312
|
let city: string; //City (optional) (default to undefined)
|
|
313
313
|
let postCode: string; //Post Code (optional) (default to undefined)
|
|
314
314
|
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
315
|
-
let tenantId:
|
|
315
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
316
316
|
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
317
317
|
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
318
318
|
let comment: string; //Comment (optional) (default to undefined)
|
|
@@ -345,7 +345,7 @@ const { status, data } = await apiInstance.postCreateNumberPort(
|
|
|
345
345
|
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
346
346
|
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
347
347
|
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
348
|
-
| **tenantId** | [**
|
|
348
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
349
349
|
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
350
350
|
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
351
351
|
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
@@ -399,7 +399,7 @@ let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
|
399
399
|
let city: string; //City (optional) (default to undefined)
|
|
400
400
|
let postCode: string; //Post Code (optional) (default to undefined)
|
|
401
401
|
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
402
|
-
let tenantId:
|
|
402
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
403
403
|
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
404
404
|
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
405
405
|
let comment: string; //Comment (optional) (default to undefined)
|
|
@@ -434,7 +434,7 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
|
|
|
434
434
|
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
435
435
|
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
436
436
|
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
437
|
-
| **tenantId** | [**
|
|
437
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
438
438
|
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
439
439
|
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
440
440
|
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
@@ -488,7 +488,7 @@ let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
|
488
488
|
let city: string; //City (optional) (default to undefined)
|
|
489
489
|
let postCode: string; //Post Code (optional) (default to undefined)
|
|
490
490
|
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
491
|
-
let tenantId:
|
|
491
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
492
492
|
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
493
493
|
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
494
494
|
let comment: string; //Comment (optional) (default to undefined)
|
|
@@ -523,7 +523,7 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
|
|
|
523
523
|
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
524
524
|
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
525
525
|
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
526
|
-
| **tenantId** | [**
|
|
526
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
527
527
|
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
528
528
|
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
529
529
|
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
|
@@ -577,7 +577,7 @@ let addressLine2: string; //Address Line 2 (optional) (default to undefined)
|
|
|
577
577
|
let city: string; //City (optional) (default to undefined)
|
|
578
578
|
let postCode: string; //Post Code (optional) (default to undefined)
|
|
579
579
|
let trunkId: number; //Trunk ID (optional) (default to undefined)
|
|
580
|
-
let tenantId:
|
|
580
|
+
let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
|
|
581
581
|
let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
|
|
582
582
|
let asap: boolean; //Port Date ASAP (optional) (default to undefined)
|
|
583
583
|
let comment: string; //Comment (optional) (default to undefined)
|
|
@@ -620,7 +620,7 @@ const { status, data } = await apiInstance.putGetAdminNumberPort(
|
|
|
620
620
|
| **city** | [**string**] | City | (optional) defaults to undefined|
|
|
621
621
|
| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
|
|
622
622
|
| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
|
|
623
|
-
| **tenantId** | [**
|
|
623
|
+
| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
|
|
624
624
|
| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
|
|
625
625
|
| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
|
|
626
626
|
| **comment** | [**string**] | Comment | (optional) defaults to undefined|
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
157
157
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
|
|
158
158
|
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
|
|
159
159
|
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
160
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | '
|
|
160
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
161
161
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
162
162
|
| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
|
|
163
163
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
210
210
|
|
|
211
211
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
212
212
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
213
|
-
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | '
|
|
213
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
214
214
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
215
215
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
216
216
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
233
233
|
|------------- | ------------- | ------------- | -------------|
|
|
234
234
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
235
235
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
236
|
-
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | '
|
|
236
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
237
237
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
238
238
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
239
239
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
package/docs/ProductsApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetAttributeSets**](#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets|
|
|
8
|
+
|[**getGetCustomerPriceLists**](#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists|
|
|
8
9
|
|[**getGetLegacyStockList**](#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing|
|
|
9
10
|
|[**getGetProducts**](#getgetproducts) | **GET** /products | Get Products|
|
|
10
11
|
|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
|
|
@@ -60,6 +61,53 @@ No authorization required
|
|
|
60
61
|
|
|
61
62
|
[[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)
|
|
62
63
|
|
|
64
|
+
# **getGetCustomerPriceLists**
|
|
65
|
+
> Array<CustomerPriceListEnum> getGetCustomerPriceLists()
|
|
66
|
+
|
|
67
|
+
Get Customer Price Lists
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import {
|
|
73
|
+
ProductsApi,
|
|
74
|
+
Configuration
|
|
75
|
+
} from 'yellowgrid-api-ts';
|
|
76
|
+
|
|
77
|
+
const configuration = new Configuration();
|
|
78
|
+
const apiInstance = new ProductsApi(configuration);
|
|
79
|
+
|
|
80
|
+
const { status, data } = await apiInstance.getGetCustomerPriceLists();
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
This endpoint does not have any parameters.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Return type
|
|
88
|
+
|
|
89
|
+
**Array<CustomerPriceListEnum>**
|
|
90
|
+
|
|
91
|
+
### Authorization
|
|
92
|
+
|
|
93
|
+
No authorization required
|
|
94
|
+
|
|
95
|
+
### HTTP request headers
|
|
96
|
+
|
|
97
|
+
- **Content-Type**: Not defined
|
|
98
|
+
- **Accept**: application/json
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### HTTP response details
|
|
102
|
+
| Status code | Description | Response headers |
|
|
103
|
+
|-------------|-------------|------------------|
|
|
104
|
+
|**200** | Price Lists | - |
|
|
105
|
+
|**400** | Bad Request | - |
|
|
106
|
+
|**401** | Unauthorised | - |
|
|
107
|
+
|**403** | Access Denied | - |
|
|
108
|
+
|
|
109
|
+
[[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)
|
|
110
|
+
|
|
63
111
|
# **getGetLegacyStockList**
|
|
64
112
|
> string getGetLegacyStockList()
|
|
65
113
|
|