yellowgrid-api-ts 3.2.239 → 3.2.241
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 +9 -0
- package/README.md +11 -0
- package/api.ts +378 -0
- package/dist/api.d.ts +296 -0
- package/dist/api.js +214 -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/AccountsApi.md +48 -0
- package/docs/AxisDataDTO.md +25 -0
- package/docs/CustomerCoordinatesDTO.md +31 -0
- package/docs/GraphDTO.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 = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = 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
|
|
@@ -202,6 +202,12 @@ exports.AuditLogEntityTypeEnum = {
|
|
|
202
202
|
Oauth2Clients: 'oauth2_clients',
|
|
203
203
|
Oauth2Tokens: 'oauth2_tokens',
|
|
204
204
|
};
|
|
205
|
+
exports.AxisDataDTOTypeEnum = {
|
|
206
|
+
Value: 'value',
|
|
207
|
+
Category: 'category',
|
|
208
|
+
Time: 'time',
|
|
209
|
+
Log: 'log',
|
|
210
|
+
};
|
|
205
211
|
exports.DivertResponseModelStatusEnum = {
|
|
206
212
|
Enabled: 'enabled',
|
|
207
213
|
Disabled: 'disabled',
|
|
@@ -211,6 +217,39 @@ exports.EventDTOStatusEnum = {
|
|
|
211
217
|
NUMBER_1: 1,
|
|
212
218
|
NUMBER_2: 2,
|
|
213
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
|
+
};
|
|
214
253
|
exports.HostingChangeResponseModelTypeEnum = {
|
|
215
254
|
NewInstance: 'New Instance',
|
|
216
255
|
BuildingInstance: 'Building Instance',
|
|
@@ -318,6 +357,25 @@ exports.ProspectDTOStatusEnum = {
|
|
|
318
357
|
NoActionRequired: 'No Action Required',
|
|
319
358
|
DoNotCall: 'Do Not Call',
|
|
320
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
|
+
};
|
|
321
379
|
exports.ServiceHealthDTOGlobalStatusEnum = {
|
|
322
380
|
NUMBER_0: 0,
|
|
323
381
|
NUMBER_1: 1,
|
|
@@ -990,6 +1048,39 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
990
1048
|
});
|
|
991
1049
|
});
|
|
992
1050
|
},
|
|
1051
|
+
/**
|
|
1052
|
+
* Get Customer Map
|
|
1053
|
+
* @param {*} [options] Override http request option.
|
|
1054
|
+
* @throws {RequiredError}
|
|
1055
|
+
*/
|
|
1056
|
+
getGetCustomerMap: function () {
|
|
1057
|
+
var args_1 = [];
|
|
1058
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
1059
|
+
args_1[_i] = arguments[_i];
|
|
1060
|
+
}
|
|
1061
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
1062
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1063
|
+
if (options === void 0) { options = {}; }
|
|
1064
|
+
return __generator(this, function (_a) {
|
|
1065
|
+
localVarPath = "/admin/accounts/customer/map";
|
|
1066
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1067
|
+
if (configuration) {
|
|
1068
|
+
baseOptions = configuration.baseOptions;
|
|
1069
|
+
}
|
|
1070
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
1071
|
+
localVarHeaderParameter = {};
|
|
1072
|
+
localVarQueryParameter = {};
|
|
1073
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1074
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1075
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1076
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1077
|
+
return [2 /*return*/, {
|
|
1078
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1079
|
+
options: localVarRequestOptions,
|
|
1080
|
+
}];
|
|
1081
|
+
});
|
|
1082
|
+
});
|
|
1083
|
+
},
|
|
993
1084
|
/**
|
|
994
1085
|
* Get Account Finance
|
|
995
1086
|
* @param {string} id Account Xero ID
|
|
@@ -2617,6 +2708,27 @@ var AccountsApiFp = function (configuration) {
|
|
|
2617
2708
|
});
|
|
2618
2709
|
});
|
|
2619
2710
|
},
|
|
2711
|
+
/**
|
|
2712
|
+
* Get Customer Map
|
|
2713
|
+
* @param {*} [options] Override http request option.
|
|
2714
|
+
* @throws {RequiredError}
|
|
2715
|
+
*/
|
|
2716
|
+
getGetCustomerMap: function (options) {
|
|
2717
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2718
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
2719
|
+
var _a, _b, _c;
|
|
2720
|
+
return __generator(this, function (_d) {
|
|
2721
|
+
switch (_d.label) {
|
|
2722
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCustomerMap(options)];
|
|
2723
|
+
case 1:
|
|
2724
|
+
localVarAxiosArgs = _d.sent();
|
|
2725
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2726
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getGetCustomerMap']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2727
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
2728
|
+
}
|
|
2729
|
+
});
|
|
2730
|
+
});
|
|
2731
|
+
},
|
|
2620
2732
|
/**
|
|
2621
2733
|
* Get Account Finance
|
|
2622
2734
|
* @param {string} id Account Xero ID
|
|
@@ -3533,6 +3645,14 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
3533
3645
|
getGetCustomerKeys: function (options) {
|
|
3534
3646
|
return localVarFp.getGetCustomerKeys(options).then(function (request) { return request(axios, basePath); });
|
|
3535
3647
|
},
|
|
3648
|
+
/**
|
|
3649
|
+
* Get Customer Map
|
|
3650
|
+
* @param {*} [options] Override http request option.
|
|
3651
|
+
* @throws {RequiredError}
|
|
3652
|
+
*/
|
|
3653
|
+
getGetCustomerMap: function (options) {
|
|
3654
|
+
return localVarFp.getGetCustomerMap(options).then(function (request) { return request(axios, basePath); });
|
|
3655
|
+
},
|
|
3536
3656
|
/**
|
|
3537
3657
|
* Get Account Finance
|
|
3538
3658
|
* @param {string} id Account Xero ID
|
|
@@ -4022,6 +4142,15 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
4022
4142
|
var _this = this;
|
|
4023
4143
|
return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerKeys(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
4024
4144
|
};
|
|
4145
|
+
/**
|
|
4146
|
+
* Get Customer Map
|
|
4147
|
+
* @param {*} [options] Override http request option.
|
|
4148
|
+
* @throws {RequiredError}
|
|
4149
|
+
*/
|
|
4150
|
+
AccountsApi.prototype.getGetCustomerMap = function (options) {
|
|
4151
|
+
var _this = this;
|
|
4152
|
+
return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerMap(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
4153
|
+
};
|
|
4025
4154
|
/**
|
|
4026
4155
|
* Get Account Finance
|
|
4027
4156
|
* @param {string} id Account Xero ID
|
|
@@ -19096,6 +19225,43 @@ var ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
19096
19225
|
});
|
|
19097
19226
|
});
|
|
19098
19227
|
},
|
|
19228
|
+
/**
|
|
19229
|
+
* Generate Reports
|
|
19230
|
+
* @summary Generate Reports
|
|
19231
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19232
|
+
* @param {*} [options] Override http request option.
|
|
19233
|
+
* @throws {RequiredError}
|
|
19234
|
+
*/
|
|
19235
|
+
postGenerateReport: function (reportRequestDTO_1) {
|
|
19236
|
+
var args_1 = [];
|
|
19237
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
19238
|
+
args_1[_i - 1] = arguments[_i];
|
|
19239
|
+
}
|
|
19240
|
+
return __awaiter(_this, __spreadArray([reportRequestDTO_1], args_1, true), void 0, function (reportRequestDTO, options) {
|
|
19241
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
19242
|
+
if (options === void 0) { options = {}; }
|
|
19243
|
+
return __generator(this, function (_a) {
|
|
19244
|
+
localVarPath = "/reports";
|
|
19245
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
19246
|
+
if (configuration) {
|
|
19247
|
+
baseOptions = configuration.baseOptions;
|
|
19248
|
+
}
|
|
19249
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
19250
|
+
localVarHeaderParameter = {};
|
|
19251
|
+
localVarQueryParameter = {};
|
|
19252
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
19253
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
19254
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
19255
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19256
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
19257
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reportRequestDTO, localVarRequestOptions, configuration);
|
|
19258
|
+
return [2 /*return*/, {
|
|
19259
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
19260
|
+
options: localVarRequestOptions,
|
|
19261
|
+
}];
|
|
19262
|
+
});
|
|
19263
|
+
});
|
|
19264
|
+
},
|
|
19099
19265
|
};
|
|
19100
19266
|
};
|
|
19101
19267
|
exports.ReportsApiAxiosParamCreator = ReportsApiAxiosParamCreator;
|
|
@@ -19126,6 +19292,29 @@ var ReportsApiFp = function (configuration) {
|
|
|
19126
19292
|
});
|
|
19127
19293
|
});
|
|
19128
19294
|
},
|
|
19295
|
+
/**
|
|
19296
|
+
* Generate Reports
|
|
19297
|
+
* @summary Generate Reports
|
|
19298
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19299
|
+
* @param {*} [options] Override http request option.
|
|
19300
|
+
* @throws {RequiredError}
|
|
19301
|
+
*/
|
|
19302
|
+
postGenerateReport: function (reportRequestDTO, options) {
|
|
19303
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
19304
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
19305
|
+
var _a, _b, _c;
|
|
19306
|
+
return __generator(this, function (_d) {
|
|
19307
|
+
switch (_d.label) {
|
|
19308
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGenerateReport(reportRequestDTO, options)];
|
|
19309
|
+
case 1:
|
|
19310
|
+
localVarAxiosArgs = _d.sent();
|
|
19311
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
19312
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReportsApi.postGenerateReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
19313
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
19314
|
+
}
|
|
19315
|
+
});
|
|
19316
|
+
});
|
|
19317
|
+
},
|
|
19129
19318
|
};
|
|
19130
19319
|
};
|
|
19131
19320
|
exports.ReportsApiFp = ReportsApiFp;
|
|
@@ -19143,6 +19332,16 @@ var ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
19143
19332
|
getGetStockReport: function (options) {
|
|
19144
19333
|
return localVarFp.getGetStockReport(options).then(function (request) { return request(axios, basePath); });
|
|
19145
19334
|
},
|
|
19335
|
+
/**
|
|
19336
|
+
* Generate Reports
|
|
19337
|
+
* @summary Generate Reports
|
|
19338
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19339
|
+
* @param {*} [options] Override http request option.
|
|
19340
|
+
* @throws {RequiredError}
|
|
19341
|
+
*/
|
|
19342
|
+
postGenerateReport: function (reportRequestDTO, options) {
|
|
19343
|
+
return localVarFp.postGenerateReport(reportRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
19344
|
+
},
|
|
19146
19345
|
};
|
|
19147
19346
|
};
|
|
19148
19347
|
exports.ReportsApiFactory = ReportsApiFactory;
|
|
@@ -19163,6 +19362,17 @@ var ReportsApi = /** @class */ (function (_super) {
|
|
|
19163
19362
|
var _this = this;
|
|
19164
19363
|
return (0, exports.ReportsApiFp)(this.configuration).getGetStockReport(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
19165
19364
|
};
|
|
19365
|
+
/**
|
|
19366
|
+
* Generate Reports
|
|
19367
|
+
* @summary Generate Reports
|
|
19368
|
+
* @param {ReportRequestDTO} [reportRequestDTO] Report Request
|
|
19369
|
+
* @param {*} [options] Override http request option.
|
|
19370
|
+
* @throws {RequiredError}
|
|
19371
|
+
*/
|
|
19372
|
+
ReportsApi.prototype.postGenerateReport = function (reportRequestDTO, options) {
|
|
19373
|
+
var _this = this;
|
|
19374
|
+
return (0, exports.ReportsApiFp)(this.configuration).postGenerateReport(reportRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
19375
|
+
};
|
|
19166
19376
|
return ReportsApi;
|
|
19167
19377
|
}(base_1.BaseAPI));
|
|
19168
19378
|
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
|
+
};
|
package/docs/AccountsApi.md
CHANGED
|
@@ -17,6 +17,7 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
17
17
|
|[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
|
|
18
18
|
|[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
|
|
19
19
|
|[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
|
|
20
|
+
|[**getGetCustomerMap**](#getgetcustomermap) | **GET** /admin/accounts/customer/map | |
|
|
20
21
|
|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
|
|
21
22
|
|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
|
|
22
23
|
|[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
|
|
@@ -738,6 +739,53 @@ No authorization required
|
|
|
738
739
|
|
|
739
740
|
[[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)
|
|
740
741
|
|
|
742
|
+
# **getGetCustomerMap**
|
|
743
|
+
> Array<CustomerCoordinatesDTO> getGetCustomerMap()
|
|
744
|
+
|
|
745
|
+
Get Customer Map
|
|
746
|
+
|
|
747
|
+
### Example
|
|
748
|
+
|
|
749
|
+
```typescript
|
|
750
|
+
import {
|
|
751
|
+
AccountsApi,
|
|
752
|
+
Configuration
|
|
753
|
+
} from 'yellowgrid-api-ts';
|
|
754
|
+
|
|
755
|
+
const configuration = new Configuration();
|
|
756
|
+
const apiInstance = new AccountsApi(configuration);
|
|
757
|
+
|
|
758
|
+
const { status, data } = await apiInstance.getGetCustomerMap();
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
### Parameters
|
|
762
|
+
This endpoint does not have any parameters.
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
### Return type
|
|
766
|
+
|
|
767
|
+
**Array<CustomerCoordinatesDTO>**
|
|
768
|
+
|
|
769
|
+
### Authorization
|
|
770
|
+
|
|
771
|
+
No authorization required
|
|
772
|
+
|
|
773
|
+
### HTTP request headers
|
|
774
|
+
|
|
775
|
+
- **Content-Type**: Not defined
|
|
776
|
+
- **Accept**: application/json
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
### HTTP response details
|
|
780
|
+
| Status code | Description | Response headers |
|
|
781
|
+
|-------------|-------------|------------------|
|
|
782
|
+
|**200** | Customer Coordinates | - |
|
|
783
|
+
|**400** | Bad Request | - |
|
|
784
|
+
|**401** | Unauthorised | - |
|
|
785
|
+
|**403** | Access Denied | - |
|
|
786
|
+
|
|
787
|
+
[[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)
|
|
788
|
+
|
|
741
789
|
# **getGetFinanceSettings**
|
|
742
790
|
> AccountFinanceDTO getGetFinanceSettings()
|
|
743
791
|
|
|
@@ -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)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# CustomerCoordinatesDTO
|
|
2
|
+
|
|
3
|
+
Customer Coordinates
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | ID | [optional] [default to undefined]
|
|
10
|
+
**company** | **string** | Company | [optional] [default to undefined]
|
|
11
|
+
**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
|
|
12
|
+
**postCode** | **string** | Post Code | [optional] [default to undefined]
|
|
13
|
+
**latitude** | **string** | Latitude | [optional] [default to undefined]
|
|
14
|
+
**longitude** | **string** | Longitude | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { CustomerCoordinatesDTO } from 'yellowgrid-api-ts';
|
|
20
|
+
|
|
21
|
+
const instance: CustomerCoordinatesDTO = {
|
|
22
|
+
id,
|
|
23
|
+
company,
|
|
24
|
+
resellerId,
|
|
25
|
+
postCode,
|
|
26
|
+
latitude,
|
|
27
|
+
longitude,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[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)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# PostGenerateReport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | Title | [optional] [default to undefined]
|
|
9
|
+
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
|
|
10
|
+
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
|
|
11
|
+
**legend** | **Array<string>** | Legend | [optional] [default to undefined]
|
|
12
|
+
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
|
|
13
|
+
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
14
|
+
**locale** | **string** | Locale | [optional] [default to undefined]
|
|
15
|
+
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [optional] [default to undefined]
|
|
16
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { PostGenerateReport200Response } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: PostGenerateReport200Response = {
|
|
24
|
+
title,
|
|
25
|
+
xAxis,
|
|
26
|
+
yAxis,
|
|
27
|
+
legend,
|
|
28
|
+
series,
|
|
29
|
+
currency,
|
|
30
|
+
locale,
|
|
31
|
+
headers,
|
|
32
|
+
rows,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|