yellowgrid-api-ts 3.2.238 → 3.2.240
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 +11 -0
- package/README.md +12 -0
- package/api.ts +472 -0
- package/dist/api.d.ts +372 -0
- package/dist/api.js +264 -4
- package/dist/models/GraphTypeEnum.d.ts +13 -0
- package/dist/models/GraphTypeEnum.js +15 -0
- package/dist/models/ReportEnum.d.ts +53 -0
- package/dist/models/ReportEnum.js +55 -0
- package/docs/AxisDataDTO.md +25 -0
- package/docs/GraphDTO.md +33 -0
- package/docs/MiscApi.md +63 -0
- package/docs/PasswordSenderDTO.md +37 -0
- package/docs/PasswordSenderEntity.md +33 -0
- package/docs/PostGenerateReport200Response.md +36 -0
- package/docs/ReportRequestDTO.md +37 -0
- package/docs/ReportsApi.md +55 -0
- package/docs/SeriesDTO.md +27 -0
- package/docs/TableDTO.md +25 -0
- package/docs/TableDataDTO.md +21 -0
- package/docs/TableRowDTO.md +21 -0
- package/models/GraphTypeEnum.ts +14 -0
- package/models/ReportEnum.ts +54 -0
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -84,10 +84,10 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
84
84
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
85
|
};
|
|
86
86
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.
|
|
88
|
-
exports.
|
|
89
|
-
exports.
|
|
90
|
-
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = void 0;
|
|
87
|
+
exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockReportItemModelCurrencyEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.SeriesDTOTypeEnum = exports.ReportRequestDTOGraphTypeEnum = exports.ReportRequestDTOReportEnum = exports.ProspectDTOStatusEnum = exports.PatchUpdateTcxHostingPriceListRequestPriceListEnum = exports.PatchUpdatePriceListRequestPriceListEnum = exports.PasswordSenderDTOIntervalTypeEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.GraphDTOCurrencyEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AxisDataDTOTypeEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelPermissionsEnum = exports.AdminUserModelRoleEnum = exports.AdminOrderRequestDTOPaymentMethodEnum = void 0;
|
|
88
|
+
exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.MiscApi = exports.MiscApiFactory = exports.MiscApiFp = exports.MiscApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.BillingApi = exports.BillingApiFactory = exports.BillingApiFp = exports.BillingApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = exports.PatchSetOnHoldStateEnum = exports.PatchSetAccountStatusStateEnum = void 0;
|
|
89
|
+
exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.ProspectsApi = exports.ProspectsApiFactory = exports.ProspectsApiFp = exports.ProspectsApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = void 0;
|
|
90
|
+
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = void 0;
|
|
91
91
|
var axios_1 = require("axios");
|
|
92
92
|
// Some imports not used depending on template conditions
|
|
93
93
|
// @ts-ignore
|
|
@@ -156,6 +156,7 @@ exports.AuditLogEntityTypeEnum = {
|
|
|
156
156
|
NumberPortNotes: 'number_port_notes',
|
|
157
157
|
PopsOfflineInstances: 'pops_offline_instances',
|
|
158
158
|
PopsOrderedItems: 'pops_ordered_items',
|
|
159
|
+
PopsPasswordSender: 'pops_password_sender',
|
|
159
160
|
PopsPrizes: 'pops_prizes',
|
|
160
161
|
PopsPrinters: 'pops_printers',
|
|
161
162
|
PopsPromoCodes: 'pops_promo_codes',
|
|
@@ -201,6 +202,12 @@ exports.AuditLogEntityTypeEnum = {
|
|
|
201
202
|
Oauth2Clients: 'oauth2_clients',
|
|
202
203
|
Oauth2Tokens: 'oauth2_tokens',
|
|
203
204
|
};
|
|
205
|
+
exports.AxisDataDTOTypeEnum = {
|
|
206
|
+
Value: 'value',
|
|
207
|
+
Category: 'category',
|
|
208
|
+
Time: 'time',
|
|
209
|
+
Log: 'log',
|
|
210
|
+
};
|
|
204
211
|
exports.DivertResponseModelStatusEnum = {
|
|
205
212
|
Enabled: 'enabled',
|
|
206
213
|
Disabled: 'disabled',
|
|
@@ -210,6 +217,39 @@ exports.EventDTOStatusEnum = {
|
|
|
210
217
|
NUMBER_1: 1,
|
|
211
218
|
NUMBER_2: 2,
|
|
212
219
|
};
|
|
220
|
+
exports.GraphDTOCurrencyEnum = {
|
|
221
|
+
Eur: 'EUR',
|
|
222
|
+
Usd: 'USD',
|
|
223
|
+
Jpy: 'JPY',
|
|
224
|
+
Bgn: 'BGN',
|
|
225
|
+
Czk: 'CZK',
|
|
226
|
+
Dkk: 'DKK',
|
|
227
|
+
Gbp: 'GBP',
|
|
228
|
+
Huf: 'HUF',
|
|
229
|
+
Pln: 'PLN',
|
|
230
|
+
Ron: 'RON',
|
|
231
|
+
Sek: 'SEK',
|
|
232
|
+
Chf: 'CHF',
|
|
233
|
+
Isk: 'ISK',
|
|
234
|
+
Nok: 'NOK',
|
|
235
|
+
Try: 'TRY',
|
|
236
|
+
Aud: 'AUD',
|
|
237
|
+
Brl: 'BRL',
|
|
238
|
+
Cad: 'CAD',
|
|
239
|
+
Cny: 'CNY',
|
|
240
|
+
Hkd: 'HKD',
|
|
241
|
+
Idr: 'IDR',
|
|
242
|
+
Ils: 'ILS',
|
|
243
|
+
Inr: 'INR',
|
|
244
|
+
Krw: 'KRW',
|
|
245
|
+
Mxn: 'MXN',
|
|
246
|
+
Myr: 'MYR',
|
|
247
|
+
Nzd: 'NZD',
|
|
248
|
+
Php: 'PHP',
|
|
249
|
+
Sgd: 'SGD',
|
|
250
|
+
Thb: 'THB',
|
|
251
|
+
Zar: 'ZAR',
|
|
252
|
+
};
|
|
213
253
|
exports.HostingChangeResponseModelTypeEnum = {
|
|
214
254
|
NewInstance: 'New Instance',
|
|
215
255
|
BuildingInstance: 'Building Instance',
|
|
@@ -287,6 +327,11 @@ exports.OrderTotalModelCurrencyEnum = {
|
|
|
287
327
|
Thb: 'THB',
|
|
288
328
|
Zar: 'ZAR',
|
|
289
329
|
};
|
|
330
|
+
exports.PasswordSenderDTOIntervalTypeEnum = {
|
|
331
|
+
Minute: 'Minute',
|
|
332
|
+
Hour: 'Hour',
|
|
333
|
+
Day: 'Day',
|
|
334
|
+
};
|
|
290
335
|
exports.PatchUpdatePriceListRequestPriceListEnum = {
|
|
291
336
|
Rrp: 'RRP',
|
|
292
337
|
Trade: 'Trade',
|
|
@@ -312,6 +357,25 @@ exports.ProspectDTOStatusEnum = {
|
|
|
312
357
|
NoActionRequired: 'No Action Required',
|
|
313
358
|
DoNotCall: 'Do Not Call',
|
|
314
359
|
};
|
|
360
|
+
exports.ReportRequestDTOReportEnum = {
|
|
361
|
+
_1: '1',
|
|
362
|
+
_2: '2',
|
|
363
|
+
_3: '3',
|
|
364
|
+
_4: '4',
|
|
365
|
+
_5: '5',
|
|
366
|
+
_6: '6',
|
|
367
|
+
_7: '7',
|
|
368
|
+
_8: '8',
|
|
369
|
+
_9: '9',
|
|
370
|
+
_10: '10',
|
|
371
|
+
};
|
|
372
|
+
exports.ReportRequestDTOGraphTypeEnum = {
|
|
373
|
+
StackedArea: 'stacked-area',
|
|
374
|
+
Table: 'table',
|
|
375
|
+
};
|
|
376
|
+
exports.SeriesDTOTypeEnum = {
|
|
377
|
+
Line: 'line',
|
|
378
|
+
};
|
|
315
379
|
exports.ServiceHealthDTOGlobalStatusEnum = {
|
|
316
380
|
NUMBER_0: 0,
|
|
317
381
|
NUMBER_1: 1,
|
|
@@ -11393,6 +11457,121 @@ exports.GetGetTenantsStatusEnum = {
|
|
|
11393
11457
|
Offline: 'Offline',
|
|
11394
11458
|
FailedOver: 'Failed Over',
|
|
11395
11459
|
};
|
|
11460
|
+
/**
|
|
11461
|
+
* MiscApi - axios parameter creator
|
|
11462
|
+
*/
|
|
11463
|
+
var MiscApiAxiosParamCreator = function (configuration) {
|
|
11464
|
+
var _this = this;
|
|
11465
|
+
return {
|
|
11466
|
+
/**
|
|
11467
|
+
* Share Credentials
|
|
11468
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11469
|
+
* @param {*} [options] Override http request option.
|
|
11470
|
+
* @throws {RequiredError}
|
|
11471
|
+
*/
|
|
11472
|
+
postSendPassword: function (passwordSenderDTO_1) {
|
|
11473
|
+
var args_1 = [];
|
|
11474
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
11475
|
+
args_1[_i - 1] = arguments[_i];
|
|
11476
|
+
}
|
|
11477
|
+
return __awaiter(_this, __spreadArray([passwordSenderDTO_1], args_1, true), void 0, function (passwordSenderDTO, options) {
|
|
11478
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11479
|
+
if (options === void 0) { options = {}; }
|
|
11480
|
+
return __generator(this, function (_a) {
|
|
11481
|
+
localVarPath = "/admin/password/send";
|
|
11482
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11483
|
+
if (configuration) {
|
|
11484
|
+
baseOptions = configuration.baseOptions;
|
|
11485
|
+
}
|
|
11486
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
11487
|
+
localVarHeaderParameter = {};
|
|
11488
|
+
localVarQueryParameter = {};
|
|
11489
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
11490
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11491
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11492
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11493
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11494
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(passwordSenderDTO, localVarRequestOptions, configuration);
|
|
11495
|
+
return [2 /*return*/, {
|
|
11496
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11497
|
+
options: localVarRequestOptions,
|
|
11498
|
+
}];
|
|
11499
|
+
});
|
|
11500
|
+
});
|
|
11501
|
+
},
|
|
11502
|
+
};
|
|
11503
|
+
};
|
|
11504
|
+
exports.MiscApiAxiosParamCreator = MiscApiAxiosParamCreator;
|
|
11505
|
+
/**
|
|
11506
|
+
* MiscApi - functional programming interface
|
|
11507
|
+
*/
|
|
11508
|
+
var MiscApiFp = function (configuration) {
|
|
11509
|
+
var localVarAxiosParamCreator = (0, exports.MiscApiAxiosParamCreator)(configuration);
|
|
11510
|
+
return {
|
|
11511
|
+
/**
|
|
11512
|
+
* Share Credentials
|
|
11513
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11514
|
+
* @param {*} [options] Override http request option.
|
|
11515
|
+
* @throws {RequiredError}
|
|
11516
|
+
*/
|
|
11517
|
+
postSendPassword: function (passwordSenderDTO, options) {
|
|
11518
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11519
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11520
|
+
var _a, _b, _c;
|
|
11521
|
+
return __generator(this, function (_d) {
|
|
11522
|
+
switch (_d.label) {
|
|
11523
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postSendPassword(passwordSenderDTO, options)];
|
|
11524
|
+
case 1:
|
|
11525
|
+
localVarAxiosArgs = _d.sent();
|
|
11526
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11527
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MiscApi.postSendPassword']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11528
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11529
|
+
}
|
|
11530
|
+
});
|
|
11531
|
+
});
|
|
11532
|
+
},
|
|
11533
|
+
};
|
|
11534
|
+
};
|
|
11535
|
+
exports.MiscApiFp = MiscApiFp;
|
|
11536
|
+
/**
|
|
11537
|
+
* MiscApi - factory interface
|
|
11538
|
+
*/
|
|
11539
|
+
var MiscApiFactory = function (configuration, basePath, axios) {
|
|
11540
|
+
var localVarFp = (0, exports.MiscApiFp)(configuration);
|
|
11541
|
+
return {
|
|
11542
|
+
/**
|
|
11543
|
+
* Share Credentials
|
|
11544
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11545
|
+
* @param {*} [options] Override http request option.
|
|
11546
|
+
* @throws {RequiredError}
|
|
11547
|
+
*/
|
|
11548
|
+
postSendPassword: function (passwordSenderDTO, options) {
|
|
11549
|
+
return localVarFp.postSendPassword(passwordSenderDTO, options).then(function (request) { return request(axios, basePath); });
|
|
11550
|
+
},
|
|
11551
|
+
};
|
|
11552
|
+
};
|
|
11553
|
+
exports.MiscApiFactory = MiscApiFactory;
|
|
11554
|
+
/**
|
|
11555
|
+
* MiscApi - object-oriented interface
|
|
11556
|
+
*/
|
|
11557
|
+
var MiscApi = /** @class */ (function (_super) {
|
|
11558
|
+
__extends(MiscApi, _super);
|
|
11559
|
+
function MiscApi() {
|
|
11560
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
11561
|
+
}
|
|
11562
|
+
/**
|
|
11563
|
+
* Share Credentials
|
|
11564
|
+
* @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
|
|
11565
|
+
* @param {*} [options] Override http request option.
|
|
11566
|
+
* @throws {RequiredError}
|
|
11567
|
+
*/
|
|
11568
|
+
MiscApi.prototype.postSendPassword = function (passwordSenderDTO, options) {
|
|
11569
|
+
var _this = this;
|
|
11570
|
+
return (0, exports.MiscApiFp)(this.configuration).postSendPassword(passwordSenderDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11571
|
+
};
|
|
11572
|
+
return MiscApi;
|
|
11573
|
+
}(base_1.BaseAPI));
|
|
11574
|
+
exports.MiscApi = MiscApi;
|
|
11396
11575
|
/**
|
|
11397
11576
|
* MyPBXToolsApi - axios parameter creator
|
|
11398
11577
|
*/
|
|
@@ -18975,6 +19154,43 @@ var ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
18975
19154
|
});
|
|
18976
19155
|
});
|
|
18977
19156
|
},
|
|
19157
|
+
/**
|
|
19158
|
+
* Generate Reports
|
|
19159
|
+
* @summary Generate Reports
|
|
19160
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19161
|
+
* @param {*} [options] Override http request option.
|
|
19162
|
+
* @throws {RequiredError}
|
|
19163
|
+
*/
|
|
19164
|
+
postGenerateReport: function (reportRequestDTO_1) {
|
|
19165
|
+
var args_1 = [];
|
|
19166
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
19167
|
+
args_1[_i - 1] = arguments[_i];
|
|
19168
|
+
}
|
|
19169
|
+
return __awaiter(_this, __spreadArray([reportRequestDTO_1], args_1, true), void 0, function (reportRequestDTO, options) {
|
|
19170
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
19171
|
+
if (options === void 0) { options = {}; }
|
|
19172
|
+
return __generator(this, function (_a) {
|
|
19173
|
+
localVarPath = "/reports";
|
|
19174
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
19175
|
+
if (configuration) {
|
|
19176
|
+
baseOptions = configuration.baseOptions;
|
|
19177
|
+
}
|
|
19178
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
19179
|
+
localVarHeaderParameter = {};
|
|
19180
|
+
localVarQueryParameter = {};
|
|
19181
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
19182
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
19183
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
19184
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19185
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
19186
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reportRequestDTO, localVarRequestOptions, configuration);
|
|
19187
|
+
return [2 /*return*/, {
|
|
19188
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
19189
|
+
options: localVarRequestOptions,
|
|
19190
|
+
}];
|
|
19191
|
+
});
|
|
19192
|
+
});
|
|
19193
|
+
},
|
|
18978
19194
|
};
|
|
18979
19195
|
};
|
|
18980
19196
|
exports.ReportsApiAxiosParamCreator = ReportsApiAxiosParamCreator;
|
|
@@ -19005,6 +19221,29 @@ var ReportsApiFp = function (configuration) {
|
|
|
19005
19221
|
});
|
|
19006
19222
|
});
|
|
19007
19223
|
},
|
|
19224
|
+
/**
|
|
19225
|
+
* Generate Reports
|
|
19226
|
+
* @summary Generate Reports
|
|
19227
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19228
|
+
* @param {*} [options] Override http request option.
|
|
19229
|
+
* @throws {RequiredError}
|
|
19230
|
+
*/
|
|
19231
|
+
postGenerateReport: function (reportRequestDTO, options) {
|
|
19232
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
19233
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
19234
|
+
var _a, _b, _c;
|
|
19235
|
+
return __generator(this, function (_d) {
|
|
19236
|
+
switch (_d.label) {
|
|
19237
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGenerateReport(reportRequestDTO, options)];
|
|
19238
|
+
case 1:
|
|
19239
|
+
localVarAxiosArgs = _d.sent();
|
|
19240
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
19241
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReportsApi.postGenerateReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
19242
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
19243
|
+
}
|
|
19244
|
+
});
|
|
19245
|
+
});
|
|
19246
|
+
},
|
|
19008
19247
|
};
|
|
19009
19248
|
};
|
|
19010
19249
|
exports.ReportsApiFp = ReportsApiFp;
|
|
@@ -19022,6 +19261,16 @@ var ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
19022
19261
|
getGetStockReport: function (options) {
|
|
19023
19262
|
return localVarFp.getGetStockReport(options).then(function (request) { return request(axios, basePath); });
|
|
19024
19263
|
},
|
|
19264
|
+
/**
|
|
19265
|
+
* Generate Reports
|
|
19266
|
+
* @summary Generate Reports
|
|
19267
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19268
|
+
* @param {*} [options] Override http request option.
|
|
19269
|
+
* @throws {RequiredError}
|
|
19270
|
+
*/
|
|
19271
|
+
postGenerateReport: function (reportRequestDTO, options) {
|
|
19272
|
+
return localVarFp.postGenerateReport(reportRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
19273
|
+
},
|
|
19025
19274
|
};
|
|
19026
19275
|
};
|
|
19027
19276
|
exports.ReportsApiFactory = ReportsApiFactory;
|
|
@@ -19042,6 +19291,17 @@ var ReportsApi = /** @class */ (function (_super) {
|
|
|
19042
19291
|
var _this = this;
|
|
19043
19292
|
return (0, exports.ReportsApiFp)(this.configuration).getGetStockReport(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
19044
19293
|
};
|
|
19294
|
+
/**
|
|
19295
|
+
* Generate Reports
|
|
19296
|
+
* @summary Generate Reports
|
|
19297
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19298
|
+
* @param {*} [options] Override http request option.
|
|
19299
|
+
* @throws {RequiredError}
|
|
19300
|
+
*/
|
|
19301
|
+
ReportsApi.prototype.postGenerateReport = function (reportRequestDTO, options) {
|
|
19302
|
+
var _this = this;
|
|
19303
|
+
return (0, exports.ReportsApiFp)(this.configuration).postGenerateReport(reportRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
19304
|
+
};
|
|
19045
19305
|
return ReportsApi;
|
|
19046
19306
|
}(base_1.BaseAPI));
|
|
19047
19307
|
exports.ReportsApi = ReportsApi;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare const GraphTypeEnum: {
|
|
2
|
+
readonly STACKED: {
|
|
3
|
+
readonly name: "STACKED";
|
|
4
|
+
readonly value: "stacked-area";
|
|
5
|
+
readonly publicValue: "Stacked Area";
|
|
6
|
+
};
|
|
7
|
+
readonly TABLE: {
|
|
8
|
+
readonly name: "TABLE";
|
|
9
|
+
readonly value: "table";
|
|
10
|
+
readonly publicValue: "Table";
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export type GraphTypeEnum = typeof GraphTypeEnum;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.GraphTypeEnum = void 0;
|
|
4
|
+
exports.GraphTypeEnum = {
|
|
5
|
+
"STACKED": {
|
|
6
|
+
"name": "STACKED",
|
|
7
|
+
"value": "stacked-area",
|
|
8
|
+
"publicValue": "Stacked Area"
|
|
9
|
+
},
|
|
10
|
+
"TABLE": {
|
|
11
|
+
"name": "TABLE",
|
|
12
|
+
"value": "table",
|
|
13
|
+
"publicValue": "Table"
|
|
14
|
+
}
|
|
15
|
+
};
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
export declare const ReportEnum: {
|
|
2
|
+
readonly STOCK: {
|
|
3
|
+
readonly name: "STOCK";
|
|
4
|
+
readonly value: 1;
|
|
5
|
+
readonly publicValue: "Stock";
|
|
6
|
+
};
|
|
7
|
+
readonly POS: {
|
|
8
|
+
readonly name: "POS";
|
|
9
|
+
readonly value: 2;
|
|
10
|
+
readonly publicValue: "POS";
|
|
11
|
+
};
|
|
12
|
+
readonly CUSTOMER_SPEND: {
|
|
13
|
+
readonly name: "CUSTOMER_SPEND";
|
|
14
|
+
readonly value: 3;
|
|
15
|
+
readonly publicValue: "Customer Spend";
|
|
16
|
+
};
|
|
17
|
+
readonly MONTHLY_SALES: {
|
|
18
|
+
readonly name: "MONTHLY_SALES";
|
|
19
|
+
readonly value: 4;
|
|
20
|
+
readonly publicValue: "Monthly Sales";
|
|
21
|
+
};
|
|
22
|
+
readonly CUSTOMER_ANNUAL_COMPARISON: {
|
|
23
|
+
readonly name: "CUSTOMER_ANNUAL_COMPARISON";
|
|
24
|
+
readonly value: 5;
|
|
25
|
+
readonly publicValue: "Customer Annual Comparison";
|
|
26
|
+
};
|
|
27
|
+
readonly LOW_STOCK: {
|
|
28
|
+
readonly name: "LOW_STOCK";
|
|
29
|
+
readonly value: 6;
|
|
30
|
+
readonly publicValue: "Low Stock";
|
|
31
|
+
};
|
|
32
|
+
readonly LEAGUE_TABLE: {
|
|
33
|
+
readonly name: "LEAGUE_TABLE";
|
|
34
|
+
readonly value: 7;
|
|
35
|
+
readonly publicValue: "League Table";
|
|
36
|
+
};
|
|
37
|
+
readonly REVENUE: {
|
|
38
|
+
readonly name: "REVENUE";
|
|
39
|
+
readonly value: 8;
|
|
40
|
+
readonly publicValue: "Revenue";
|
|
41
|
+
};
|
|
42
|
+
readonly EXPENDITURE: {
|
|
43
|
+
readonly name: "EXPENDITURE";
|
|
44
|
+
readonly value: 9;
|
|
45
|
+
readonly publicValue: "Expenditure";
|
|
46
|
+
};
|
|
47
|
+
readonly TECH_SUPPORT_CUSTOMERS: {
|
|
48
|
+
readonly name: "TECH_SUPPORT_CUSTOMERS";
|
|
49
|
+
readonly value: 10;
|
|
50
|
+
readonly publicValue: "Tech Support Customers";
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
export type ReportEnum = typeof ReportEnum;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ReportEnum = void 0;
|
|
4
|
+
exports.ReportEnum = {
|
|
5
|
+
"STOCK": {
|
|
6
|
+
"name": "STOCK",
|
|
7
|
+
"value": 1,
|
|
8
|
+
"publicValue": "Stock"
|
|
9
|
+
},
|
|
10
|
+
"POS": {
|
|
11
|
+
"name": "POS",
|
|
12
|
+
"value": 2,
|
|
13
|
+
"publicValue": "POS"
|
|
14
|
+
},
|
|
15
|
+
"CUSTOMER_SPEND": {
|
|
16
|
+
"name": "CUSTOMER_SPEND",
|
|
17
|
+
"value": 3,
|
|
18
|
+
"publicValue": "Customer Spend"
|
|
19
|
+
},
|
|
20
|
+
"MONTHLY_SALES": {
|
|
21
|
+
"name": "MONTHLY_SALES",
|
|
22
|
+
"value": 4,
|
|
23
|
+
"publicValue": "Monthly Sales"
|
|
24
|
+
},
|
|
25
|
+
"CUSTOMER_ANNUAL_COMPARISON": {
|
|
26
|
+
"name": "CUSTOMER_ANNUAL_COMPARISON",
|
|
27
|
+
"value": 5,
|
|
28
|
+
"publicValue": "Customer Annual Comparison"
|
|
29
|
+
},
|
|
30
|
+
"LOW_STOCK": {
|
|
31
|
+
"name": "LOW_STOCK",
|
|
32
|
+
"value": 6,
|
|
33
|
+
"publicValue": "Low Stock"
|
|
34
|
+
},
|
|
35
|
+
"LEAGUE_TABLE": {
|
|
36
|
+
"name": "LEAGUE_TABLE",
|
|
37
|
+
"value": 7,
|
|
38
|
+
"publicValue": "League Table"
|
|
39
|
+
},
|
|
40
|
+
"REVENUE": {
|
|
41
|
+
"name": "REVENUE",
|
|
42
|
+
"value": 8,
|
|
43
|
+
"publicValue": "Revenue"
|
|
44
|
+
},
|
|
45
|
+
"EXPENDITURE": {
|
|
46
|
+
"name": "EXPENDITURE",
|
|
47
|
+
"value": 9,
|
|
48
|
+
"publicValue": "Expenditure"
|
|
49
|
+
},
|
|
50
|
+
"TECH_SUPPORT_CUSTOMERS": {
|
|
51
|
+
"name": "TECH_SUPPORT_CUSTOMERS",
|
|
52
|
+
"value": 10,
|
|
53
|
+
"publicValue": "Tech Support Customers"
|
|
54
|
+
}
|
|
55
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AxisDataDTO
|
|
2
|
+
|
|
3
|
+
Graph Axis Data
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | Type | [optional] [default to undefined]
|
|
10
|
+
**data** | **Array<string>** | Data | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | Name | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AxisDataDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: AxisDataDTO = {
|
|
19
|
+
type,
|
|
20
|
+
data,
|
|
21
|
+
name,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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/GraphDTO.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# GraphDTO
|
|
2
|
+
|
|
3
|
+
Graph
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**title** | **string** | Title | [optional] [default to undefined]
|
|
10
|
+
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
|
|
11
|
+
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
|
|
12
|
+
**legend** | **Array<string>** | Legend | [optional] [default to undefined]
|
|
13
|
+
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
|
|
14
|
+
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
15
|
+
**locale** | **string** | Locale | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { GraphDTO } from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: GraphDTO = {
|
|
23
|
+
title,
|
|
24
|
+
xAxis,
|
|
25
|
+
yAxis,
|
|
26
|
+
legend,
|
|
27
|
+
series,
|
|
28
|
+
currency,
|
|
29
|
+
locale,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[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/MiscApi.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# MiscApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**postSendPassword**](#postsendpassword) | **POST** /admin/password/send | |
|
|
8
|
+
|
|
9
|
+
# **postSendPassword**
|
|
10
|
+
> PasswordSenderDTO postSendPassword()
|
|
11
|
+
|
|
12
|
+
Share Credentials
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
MiscApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
PasswordSenderDTO
|
|
21
|
+
} from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new MiscApi(configuration);
|
|
25
|
+
|
|
26
|
+
let passwordSenderDTO: PasswordSenderDTO; //Password Sender Request (optional)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.postSendPassword(
|
|
29
|
+
passwordSenderDTO
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **passwordSenderDTO** | **PasswordSenderDTO**| Password Sender Request | |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**PasswordSenderDTO**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
No authorization required
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: application/json
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | Password Sender Response | - |
|
|
58
|
+
|**400** | Bad Request | - |
|
|
59
|
+
|**401** | Unauthorised | - |
|
|
60
|
+
|**403** | Access Denied | - |
|
|
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)
|
|
63
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# PasswordSenderDTO
|
|
2
|
+
|
|
3
|
+
Password Sender Request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**username** | **string** | Username | [optional] [default to undefined]
|
|
10
|
+
**password** | **string** | Password | [optional] [default to undefined]
|
|
11
|
+
**expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
|
|
12
|
+
**intervalType** | **string** | Interval Type | [optional] [default to undefined]
|
|
13
|
+
**expiry** | **string** | Expiry | [optional] [default to undefined]
|
|
14
|
+
**recipient** | **Array<string>** | Recipient | [optional] [default to undefined]
|
|
15
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
16
|
+
**description** | **string** | Description | [optional] [default to undefined]
|
|
17
|
+
**passwordUrl** | **string** | Password URL | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { PasswordSenderDTO } from 'yellowgrid-api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: PasswordSenderDTO = {
|
|
25
|
+
username,
|
|
26
|
+
password,
|
|
27
|
+
expiryInterval,
|
|
28
|
+
intervalType,
|
|
29
|
+
expiry,
|
|
30
|
+
recipient,
|
|
31
|
+
url,
|
|
32
|
+
description,
|
|
33
|
+
passwordUrl,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|